Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: change schema to chinese #1624

Merged
merged 1 commit into from
Jul 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion dongtai_protocol/views/agent_download.py
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ def make_download_handler(self, language, user_id):

@extend_schema(operation_id="agent download api",
tags=[_('Agent Protocol')],
summary=_('Agent download'), # type: ignore
summary="Agent 下载",
parameters=[
DongTaiParameter.OPENAPI_URL,
DongTaiParameter.PROJECT_NAME,
Expand Down
8 changes: 3 additions & 5 deletions dongtai_protocol/views/health_oss.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,10 @@
# @description :
######################################################################

import oss2
from drf_spectacular.utils import extend_schema
from oss2.exceptions import RequestError
import logging
from dongtai_protocol.utils import checkossstatus, STATUSMAP
from dongtai_common.endpoint import OpenApiEndPoint, R, UserEndPoint
from dongtai_protocol.utils import checkossstatus
from dongtai_common.endpoint import R, UserEndPoint

logger = logging.getLogger("dongtai.openapi")

Expand All @@ -21,7 +19,7 @@ class OSSHealthView(UserEndPoint):
description='Check OSS Health',
responses=R,
methods=['GET'],
summary="Check OSS Health",
summary="检查 OSS 健康",
tags=["OSS"],
)
def get(self, request):
Expand Down
2 changes: 1 addition & 1 deletion dongtai_protocol/views/hook_profiles.py
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ def get_profiles(user=None, language_id=JAVA, full=False, system_only=False):
],
responses=R,
methods=['GET'],
summary="Pull Agent Engine Hook Rule",
summary="拉取 Agent Engine Hook Rule",
tags=['Agent服务端交互协议'],
)
def get(self, request):
Expand Down
19 changes: 5 additions & 14 deletions dongtai_web/aggr_vul/aggr_vul_list.py
Original file line number Diff line number Diff line change
@@ -1,33 +1,24 @@
# 按类型获取 组件漏洞 应用漏洞列表
from typing import Any
from elasticsearch_dsl import Q, Search
from elasticsearch_dsl import Q
from dongtai_common.models.asset_vul import IastAssetVulnerabilityDocument
from dongtai_common.common.utils import make_hash
from dongtai_conf import settings
from django.core.cache import cache
from dongtai_common.models.vul_level import IastVulLevel
from dongtai_common.models.project import IastProject
from dongtai_common.models.program_language import IastProgramLanguage
from dongtai_common.models.vulnerablity import IastVulnerabilityStatus
from dongtai_common.models.strategy import IastStrategyModel
from elasticsearch_dsl import A
from elasticsearch import Elasticsearch
import json
import time
import logging
from dongtai_common.endpoint import R
from django.forms import model_to_dict
from dongtai_common.endpoint import UserEndPoint

from dongtai_web.utils import extend_schema_with_envcheck
from dongtai_web.serializers.aggregation import AggregationArgsSerializer
from rest_framework.serializers import ValidationError
from django.utils.translation import gettext_lazy as _
from dongtai_web.aggregation.aggregation_common import getAuthUserInfo, turnIntListOfStr, getAuthBaseQuery, auth_user_list_str
from dongtai_web.aggregation.aggregation_common import turnIntListOfStr, auth_user_list_str
import pymysql
from dongtai_web.serializers.vul import VulSerializer
from dongtai_common.models.asset_vul import IastAssetVul, IastVulAssetRelation, IastAssetVulType, IastAssetVulTypeRelation
from dongtai_common.models import AGGREGATION_ORDER, LANGUAGE_ID_DICT, SHARE_CONFIG_DICT, APP_LEVEL_RISK, LICENSE_RISK, \
from dongtai_common.models.asset_vul import IastAssetVul, IastVulAssetRelation, IastAssetVulTypeRelation
from dongtai_common.models import AGGREGATION_ORDER, LANGUAGE_ID_DICT, APP_LEVEL_RISK, LICENSE_RISK, \
SCA_AVAILABILITY_DICT
from dongtai_conf.settings import ELASTICSEARCH_STATE
from typing import List
Expand Down Expand Up @@ -62,7 +53,7 @@ class GetAggregationVulList(UserEndPoint):
@extend_schema_with_envcheck(
request=AggregationArgsSerializer,
tags=[_('VulList')],
summary=_('Vul List Select'),
summary=_('组件漏洞列表'),
description=_("select sca vul and app vul by keywords"),
)
# 组件漏洞 列表
Expand Down
5 changes: 2 additions & 3 deletions dongtai_web/aggr_vul/aggr_vul_summary.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,13 @@
from dongtai_web.serializers.aggregation import AggregationArgsSerializer
from django.utils.translation import gettext_lazy as _
from dongtai_common.endpoint import R
from dongtai_web.aggregation.aggregation_common import auth_user_list_str
from dongtai_common.models import LANGUAGE_DICT
from rest_framework.serializers import ValidationError
from django.db import connection
from dongtai_common.common.utils import cached_decorator
from dongtai_common.models import APP_LEVEL_RISK
from dongtai_common.models.user import User
from typing import Dict, Union, List
from typing import List
from typing import TypedDict

class Level(TypedDict):
Expand Down Expand Up @@ -322,7 +321,7 @@ class GetScaSummary(UserEndPoint):
@extend_schema_with_envcheck(
request=AggregationArgsSerializer,
tags=[_('VulList')],
summary=_('Vul List Select'),
summary=_('组件漏洞列表'),
description=_(
"count sca vul and app vul by keywords"
),
Expand Down
6 changes: 2 additions & 4 deletions dongtai_web/aggregation/aggregation_del.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,8 @@
from dongtai_common.models.asset_vul import IastVulAssetRelation

from dongtai_common.models.vulnerablity import IastVulnerabilityModel
from dongtai_common.models.asset import Asset
from django.utils.translation import gettext_lazy as _
from dongtai_web.utils import extend_schema_with_envcheck, get_response_serializer
from django.db import connection
from dongtai_web.utils import extend_schema_with_envcheck
from dongtai_web.aggregation.aggregation_common import turnIntListOfStr
import logging

Expand All @@ -21,7 +19,7 @@ class DelVulMany(UserEndPoint):
@extend_schema_with_envcheck(

tags=[_('VulList')],
summary=_('Vul List delete'),
summary=_('删除漏洞列表'),
description=_(
"delete many app vul and dongtai_sca vul"
),
Expand Down
7 changes: 2 additions & 5 deletions dongtai_web/aggregation/aggregation_project_del.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,8 @@
from dongtai_common.models.asset_vul import IastVulAssetRelation

from dongtai_common.models.vulnerablity import IastVulnerabilityModel
from dongtai_common.models.asset import Asset
from django.utils.translation import gettext_lazy as _
from dongtai_web.utils import extend_schema_with_envcheck, get_response_serializer
from django.db import connection
from dongtai_web.aggregation.aggregation_common import turnIntListOfStr
from dongtai_web.utils import extend_schema_with_envcheck
import logging

logger = logging.getLogger('dongtai-dongtai_conf')
Expand All @@ -20,7 +17,7 @@ class DelVulProjectLevel(UserEndPoint):

@extend_schema_with_envcheck(
tags=[_('VulList')],
summary=_('Vul List delete'),
summary=_('删除 Vul List'),
description=_("delete many app vul and dongtai_sca vul"),
)
def post(self, request):
Expand Down
15 changes: 2 additions & 13 deletions dongtai_web/enum/hook_rules.py
Original file line number Diff line number Diff line change
@@ -1,28 +1,17 @@
import logging
import json

from django.db.models import Q, F, Count
from django.utils.translation import gettext_lazy as _
from dongtai_common.endpoint import UserEndPoint, R
from rest_framework.viewsets import ViewSet
from dongtai_common.models.agent import IastAgent
from dongtai_common.models.strategy import IastStrategyModel
from dongtai_common.models.vulnerablity import IastVulnerabilityModel
from django.core.cache import cache
from dongtai_web.utils import extend_schema_with_envcheck, get_response_serializer
from dongtai_common.models.dast_integration import IastDastIntegration
from rest_framework import serializers
from dongtai_web.utils import extend_schema_with_envcheck
from rest_framework import viewsets
from rest_framework.serializers import ValidationError
from dongtai_common.models.profile import IastProfile
from dongtai_conf.settings import DEFAULT_TAINT_VALUE_RANGE_COMMANDS, DEFAULT_IAST_VALUE_TAG

logger = logging.getLogger('dongtai-webapi')


class HookRuleEnumEndPoint(UserEndPoint, viewsets.ViewSet):

@extend_schema_with_envcheck(summary=_('Hook Rule Enums'),
@extend_schema_with_envcheck(summary=_('Hook Rule 枚举'),
description=_("Hook Rule Enums "),
tags=[_('Hook Rule')])
def get_enums(self, request):
Expand Down
14 changes: 3 additions & 11 deletions dongtai_web/header_vul/base.py
Original file line number Diff line number Diff line change
@@ -1,20 +1,12 @@
import logging

from dongtai_common.endpoint import UserEndPoint, R
from dongtai_common.models.hook_type import HookType
from dongtai_common.utils import const

from dongtai_web.serializers.hook_type_strategy import HookTypeSerialize
from django.utils.translation import gettext_lazy as _
from rest_framework import serializers
from dongtai_web.utils import extend_schema_with_envcheck, get_response_serializer
from django.utils.text import format_lazy
from dongtai_web.utils import extend_schema_with_envcheck
from rest_framework.serializers import ValidationError
from dongtai_web.serializers.hook_strategy import HOOK_TYPE_CHOICE
from rest_framework import viewsets
from django.db import connection
from django.db import models
from dongtai_common.permissions import TalentAdminPermission
from dongtai_common.models.header_vulnerablity import IastHeaderVulnerability, IastHeaderVulnerabilityDetail
from django.db.models import Q
from typing import Dict
Expand Down Expand Up @@ -62,7 +54,7 @@ def get_permissions(self):
@extend_schema_with_envcheck(
[HeaderVulArgsSerializer],
tags=[_('Header Vul')],
summary=_('Header Vul List'),
summary=_('Header Vul 列表'),
description=_("Get the item corresponding to the user"),
)
def list(self, request):
Expand All @@ -84,7 +76,7 @@ def list(self, request):

@extend_schema_with_envcheck(
tags=[_('Header Vul')],
summary=_('Header Vul delete'),
summary=_('Header Vul 删除'),
description=_("Get the item corresponding to the user"),
)
def delete(self, request, pk):
Expand Down
8 changes: 1 addition & 7 deletions dongtai_web/views/project_summary.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,11 @@
from dongtai_common.models.agent import IastAgent
from dongtai_common.models.project import IastProject
from dongtai_common.models.project_version import IastProjectVersion
from dongtai_common.models.vul_level import IastVulLevel
from dongtai_common.models.vulnerablity import IastVulnerabilityModel
from dongtai_web.base.project_version import get_project_version, get_project_version_by_id, ProjectsVersionDataSerializer
from django.utils.translation import gettext_lazy as _
from dongtai_common.models.vulnerablity import IastVulnerabilityStatus
from dongtai_web.serializers.project import ProjectSerializer
from dongtai_common.models.hook_type import HookType
from django.db.models import Q
from rest_framework import serializers
from dongtai_web.utils import extend_schema_with_envcheck, get_response_serializer
from dongtai_common.models.strategy import IastStrategyModel
from dongtai_web.views.utils.commonstats import get_summary_by_project
from dongtai_common.utils import const

Expand Down Expand Up @@ -97,7 +91,7 @@ def weeks_ago(week=1):

@extend_schema_with_envcheck(
tags=[_('Project')],
summary=_('Projects Summary'),
summary=_('项目总结'),
description=_("Get project deatils and its statistics data about vulnerablity."
),
response_schema=_ProjectSummaryResponseSerializer,
Expand Down
27 changes: 9 additions & 18 deletions dongtai_web/views/sensitive_info_rule.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
BatchStatusUpdateSerializerView,
AllStatusUpdateSerializerView,
)
from dongtai_common.permissions import TalentAdminPermission
try:
import re2 as re
except ImportError as e:
Expand All @@ -25,24 +24,16 @@
from dongtai_common.models.sensitive_info import IastPatternType, IastSensitiveInfoRule
from django.db.models import Q
import time
from dongtai_common.models.user import User
from dongtai_common.models.strategy import IastStrategyModel
from django.db import models
import logging

from dongtai_common.endpoint import UserEndPoint, R
from dongtai_common.models.hook_type import HookType
from dongtai_common.utils import const

from dongtai_web.serializers.hook_type_strategy import HookTypeSerialize
from django.utils.translation import gettext_lazy as _
from rest_framework import serializers
from dongtai_web.utils import extend_schema_with_envcheck, get_response_serializer
from django.utils.text import format_lazy
from dongtai_web.utils import extend_schema_with_envcheck
from rest_framework.serializers import ValidationError
from dongtai_web.serializers.hook_strategy import HOOK_TYPE_CHOICE
from rest_framework import viewsets
from django.db import connection

logger = logging.getLogger('dongtai-webapi')

Expand Down Expand Up @@ -168,7 +159,7 @@ def list(self, request):
@extend_schema_with_envcheck(
request=SensitiveInfoRuleCreateSerializer,
tags=[_('SensitiveInfoRule')],
summary=_('SensitiveInfoRule Create'),
summary=_('敏感信息规则创建'),
description=_("Get the item corresponding to the user, support fuzzy search based on name."
),
)
Expand Down Expand Up @@ -202,7 +193,7 @@ def create(self, request):
@extend_schema_with_envcheck(
request=SensitiveInfoRuleCreateSerializer,
tags=[_('SensitiveInfoRule')],
summary=_('SensitiveInfoRule Update'),
summary=_('敏感信息规则更新'),
description=_("Get the item corresponding to the user, support fuzzy search based on name."
),
)
Expand All @@ -224,7 +215,7 @@ def update(self, request, pk):

@extend_schema_with_envcheck(
tags=[_('SensitiveInfoRule')],
summary=_('SensitiveInfoRule delete'),
summary=_('敏感信息规则删除'),
description=_("Get the item corresponding to the user, support fuzzy search based on name."
),
)
Expand All @@ -236,7 +227,7 @@ def destory(self, request, pk):

@extend_schema_with_envcheck(
tags=[_('SensitiveInfoRule')],
summary=_('SensitiveInfoRule get'),
summary=_('敏感信息规则获取'),
description=_("Get the item corresponding to the user, support fuzzy search based on name."
),
)
Expand All @@ -253,7 +244,7 @@ class SensitiveInfoPatternTypeView(UserEndPoint):

@extend_schema_with_envcheck(
tags=[_('SensitiveInfoRule')],
summary=_('SensitiveInfoRule Pattern Type List'),
summary=_('敏感信息规则模式类型列表'),
description=_("Get the item corresponding to the user."
),
)
Expand All @@ -266,7 +257,7 @@ class SensitiveInfoPatternValidationView(UserEndPoint):
@extend_schema_with_envcheck(
request=_RegexPatternValidationSerializer,
tags=[_('SensitiveInfoRule')],
summary=_('SensitiveInfoRule validated_data'),
summary=_('敏感信息规则数据验证'),
description=_("Get the item corresponding to the user, support fuzzy search based on name."
),
)
Expand Down Expand Up @@ -339,7 +330,7 @@ class SensitiveInfoRuleBatchView(BatchStatusUpdateSerializerView):
@extend_schema_with_envcheck(
request=BatchStatusUpdateSerializerView.serializer,
tags=[_('SensitiveInfoRule')],
summary=_('SensitiveInfoRule batch status'),
summary=_('敏感信息规则状态批量更新'),
description=_("batch update status."),
)
def post(self, request):
Expand All @@ -356,7 +347,7 @@ class SensitiveInfoRuleAllView(AllStatusUpdateSerializerView):
@extend_schema_with_envcheck(
request=AllStatusUpdateSerializerView.serializer,
tags=[_('SensitiveInfoRule')],
summary=_('SensitiveInfoRule all status'),
summary=_('敏感信息规则全部状态更新'),
description=_("all update status."),
)
def post(self, request):
Expand Down
2 changes: 1 addition & 1 deletion dongtai_web/views/user_detail.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

class UserDetailEndPoint(TalentAdminEndPoint):
@extend_schema(
summary=_("User Detail"),
summary=_("用户详情"),
tags=[_("User")],
)
def get(self, request, user_id):
Expand Down
4 changes: 2 additions & 2 deletions dongtai_web/views/user_token.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@ def get(self, request):

class UserDepartmentToken(UserEndPoint):
name = "iast-v1-user-department-token"
description = _("Get Department Deploy token")
description = _("获取部门部署 token")

@extend_schema(
summary=_("Get Department Deploy token"),
summary=_("获取部门部署 token"),
tags=[_("User")],
)
def get(self, request):
Expand Down
Loading