Skip to content

Commit 2b1c49c

Browse files
author
Xinkai Yi
committed
fix: 修改接口描述不规范问题
1 parent 7f129df commit 2b1c49c

7 files changed

Lines changed: 16 additions & 11 deletions

File tree

bk-plugin-framework/bk_plugin_framework/services/bpf_service/api/callback.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ class PluginCallback(APIView):
5454
user_verified_required=True,
5555
app_verified_required=True,
5656
resource_permission_required=True,
57-
description_en="插件调用",
57+
description_en="plugin callback",
5858
match_subpath=False,
5959
),
6060
)

bk-plugin-framework/bk_plugin_framework/services/bpf_service/api/detail.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,15 +69,16 @@ class Detail(APIView):
6969
permission_classes = [permissions.AllowAny]
7070

7171
@extend_schema(
72-
summary="Get plugin detail for specific version",
72+
summary="获取指定版本的插件详情",
73+
operation_id="plugin_detail",
7374
responses={200: standard_response_enveloper(DetailResponseSerializer)},
7475
extensions=gen_apigateway_resource_config(
7576
is_public=True,
7677
allow_apply_permission=True,
7778
user_verified_required=True,
7879
app_verified_required=True,
7980
resource_permission_required=True,
80-
description_en="插件调用",
81+
description_en="Get plugin detail for specific version",
8182
match_subpath=False,
8283
),
8384
)

bk-plugin-framework/bk_plugin_framework/services/bpf_service/api/invoke.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ class Invoke(APIView):
5959
permission_classes = [ScopeAllowPermission]
6060

6161
@extend_schema(
62-
summary="插件调用",
62+
summary="调用指定版本插件",
6363
operation_id="invoke",
6464
request=InvokeParamsSerializer,
6565
responses={200: standard_response_enveloper(InvokeResponseSerializer)},
@@ -69,7 +69,7 @@ class Invoke(APIView):
6969
user_verified_required=True,
7070
app_verified_required=True,
7171
resource_permission_required=True,
72-
description_en="插件调用",
72+
description_en="Invoke specific version plugin",
7373
match_subpath=False,
7474
),
7575
)

bk-plugin-framework/bk_plugin_framework/services/bpf_service/api/logs.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,15 +45,16 @@ class Logs(APIView):
4545
permission_classes = [permissions.AllowAny]
4646

4747
@extend_schema(
48-
summary="Get plugin execution log with trace_id",
48+
summary="获取插件执行日志",
49+
operation_id="plugin_logs",
4950
responses={200: standard_response_enveloper(LogsResponseSerializer)},
5051
extensions=gen_apigateway_resource_config(
5152
is_public=True,
5253
allow_apply_permission=True,
5354
user_verified_required=True,
5455
app_verified_required=True,
5556
resource_permission_required=True,
56-
description_en="插件调用",
57+
description_en="Get plugin execution log with trace_id",
5758
match_subpath=False,
5859
),
5960
)

bk-plugin-framework/bk_plugin_framework/services/bpf_service/api/meta.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,15 +63,16 @@ class Meta(APIView):
6363
permission_classes = [permissions.AllowAny]
6464

6565
@extend_schema(
66-
summary="Get plugin meta info",
66+
summary="获取插件元信息",
67+
operation_id="plugin_meta_info",
6768
responses={200: standard_response_enveloper(MetaResponseSerializer)},
6869
extensions=gen_apigateway_resource_config(
6970
is_public=True,
7071
allow_apply_permission=True,
7172
user_verified_required=True,
7273
app_verified_required=True,
7374
resource_permission_required=True,
74-
description_en="插件调用",
75+
description_en="Get plugin meta info",
7576
match_subpath=False,
7677
),
7778
)

bk-plugin-framework/bk_plugin_framework/services/bpf_service/api/plugin_api_dispatch.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ class PluginAPIDispatch(APIView):
9090
user_verified_required=True,
9191
app_verified_required=True,
9292
resource_permission_required=True,
93-
description_en="插件调用",
93+
description_en="Plugin API dispatch",
9494
match_subpath=False,
9595
),
9696
)

bk-plugin-framework/bk_plugin_framework/services/bpf_service/api/schedule.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,8 @@ class Schedule(APIView):
5757

5858
@extend_schema(
5959
summary="获取插件调度详情",
60+
operation_id="plugin_schedule",
61+
parameters=[ScheduleParamsSerializer],
6062
request=ScheduleParamsSerializer,
6163
responses={200: standard_response_enveloper(ScheduleResponseSerializer)},
6264
extensions=gen_apigateway_resource_config(
@@ -65,7 +67,7 @@ class Schedule(APIView):
6567
user_verified_required=True,
6668
app_verified_required=True,
6769
resource_permission_required=True,
68-
description_en="插件调用",
70+
description_en="Get plugin schedule detail with trace_id",
6971
match_subpath=False,
7072
),
7173
)

0 commit comments

Comments
 (0)