docs: some apigw doc (#2768)

TencentBlueKing · Aug 9, 2024 · 76af66b · 76af66b
1 parent 66adf2b
commit 76af66b
Show file tree

Hide file tree

Showing 7 changed files with 34 additions and 34 deletions.
diff --git a/saas/VERSION b/saas/VERSION
@@ -1 +1 @@
-1.10.29
+1.10.30
diff --git a/saas/resources/apigateway/docs/en/application_grant_policy.md.j2 b/saas/resources/apigateway/docs/en/application_grant_policy.md.j2
@@ -65,7 +65,7 @@ the `create_job` operation of the `bk_job` system is not associated with any res
   ],
   "applicant": "user001",
   "reason": "for grant policies",
-  "expired_at: 1704042061
+  "expired_at": 1704042061
 }
 ```
 
@@ -87,11 +87,11 @@ the `view_job` operation of the `bk_job` system is associated with the `job` res
             [  # an array represents a topology path of an instance, and the topology path must be consistent with the resource link of the instance view, business (biz)-job (job)
               {
                 "type": "biz",  # the first layer of resources in the instance view
-                "id": "biz1",
+                "id": "biz1"
               },
               {
                 "type": "job",  # the second layer of the resource topology path in the instance view
-                "id": "job1",
+                "id": "job1"
               }
             ]
           ]
@@ -123,11 +123,11 @@ the `execute_job` operation of the `bk_job` system is associated with the `job`
             [  # 业务(biz)-作业(job)
               {
                 "type": "biz",
-                "id": "biz1",
+                "id": "biz1"
               },
               {
                 "type": "job",
-                "id": "job1",
+                "id": "job1"
               }
             ]
           ]
@@ -139,16 +139,16 @@ the `execute_job` operation of the `bk_job` system is associated with the `job`
             [  # 4层的拓扑路径, 必须与实例视图的资源链路一致: 业务(biz)-集群(set)-模块(module)-主机(host)
               {
                 "type": "biz",
-                "id": "biz1",
+                "id": "biz1"
               }, {
                 "type": "set",
-                "id": "set1",
+                "id": "set1"
               }, {
                 "type": "module",
-                "id": "module1",
+                "id": "module1"
               }, {
                 "type": "host",
-                "id": "host1",
+                "id": "host1"
               }
             ]
           ],

diff --git a/saas/resources/apigateway/docs/en/management_groups_policies_delete.md.j2 b/saas/resources/apigateway/docs/en/management_groups_policies_delete.md.j2
@@ -5,9 +5,9 @@
 | Field | Type | Required | Location | Description |
 | | group_id | int | path | yes | user_group_id
 | group_id | int | path | yes | user_group_id |
-| system | string | body | Yes | Access to system unique identifier |
-| actions | array[object] | yes | body | actions |
-| resources | array[object] | yes | body | resource topology, the order of the resource types must be the same as the order in which the actions are registered |
+| system | string | body | yes | Access to system unique identifier |
+| actions | array[object] | body | yes | actions |
+| resources | array[object] | body | yes | resource topology, the order of the resource types must be the same as the order in which the actions are registered |
 
 actions
 

diff --git a/saas/resources/apigateway/docs/en/management_users_grade_managers.md.j2 b/saas/resources/apigateway/docs/en/management_users_grade_managers.md.j2
@@ -5,8 +5,8 @@
 
 | Field | Type | Required | Location | Description |
 | --------|--------|--------|--------|--------|--------|--------|
-| system | string| yes | body | System ID, i.e. query the list of hierarchical administrators created by a system |
-| uesr_id | string | yes | body | User ID, i.e. username |
+| system | string| yes | query | System ID, i.e. query the list of hierarchical administrators created by a system |
+| uesr_id | string | yes | query | User ID, i.e. username |
 
 #### Response
 

diff --git a/saas/resources/apigateway/docs/zh/application_grant_policy.md.j2 b/saas/resources/apigateway/docs/zh/application_grant_policy.md.j2
@@ -65,7 +65,7 @@ related_resource_types.attributes.values
   ],
   "applicant": "user001",
   "reason": "for grant policies",
-  "expired_at: 1704042061
+  "expired_at": 1704042061
 }
 ```
 
@@ -87,11 +87,11 @@ related_resource_types.attributes.values
             [  # 一个数组表示一个实例的拓扑路径, 拓扑路径必须与实例视图的资源链路一致, 业务(biz)-作业(job)
               {
                 "type": "biz",  # 实例视图中资源的第一层业务
-                "id": "biz1",
+                "id": "biz1"
               },
               {
                 "type": "job",  # 实例视图中资源拓扑路径的第二层作业
-                "id": "job1",
+                "id": "job1"
               }
             ]
           ]
@@ -125,11 +125,11 @@ related_resource_types.attributes.values
             [  # 业务(biz)-作业(job)
               {
                 "type": "biz",
-                "id": "biz1",
+                "id": "biz1"
               },
               {
                 "type": "job",
-                "id": "job1",
+                "id": "job1"
               }
             ]
           ]
@@ -141,16 +141,16 @@ related_resource_types.attributes.values
             [  # 4层的拓扑路径, 必须与实例视图的资源链路一致: 业务(biz)-集群(set)-模块(module)-主机(host)
               {
                 "type": "biz",
-                "id": "biz1",
+                "id": "biz1"
               }, {
                 "type": "set",
-                "id": "set1",
+                "id": "set1"
               }, {
                 "type": "module",
-                "id": "module1",
+                "id": "module1"
               }, {
                 "type": "host",
-                "id": "host1",
+                "id": "host1"
               }
             ]
           ],

diff --git a/saas/resources/apigateway/docs/zh/management_groups_policies_delete.md.j2 b/saas/resources/apigateway/docs/zh/management_groups_policies_delete.md.j2
@@ -2,12 +2,12 @@
 
 #### Parameters
 
-| 字段 | 类型 | 位置 | 必须 | 描述 |
-|---|---|---|---|---|
-| group_id | int | path | 是 | 用户组ID |
-| system | string | body | 是 | 接入系统唯一标识 |
-| actions |  array[object]   | 是   | body | 操作 |
-| resources |  array[object]   | 是   | body | 资源拓扑, 资源类型的顺序必须操作注册时的顺序一致 |
+| 字段 | 类型                    | 位置   | 必须 | 描述 |
+|---|-----------------------|------|-|---|
+| group_id | int                   | path | 是 | 用户组ID |
+| system | string                | body | 是 | 接入系统唯一标识 |
+| actions | array[object]   | body | 是 | 操作 |
+| resources | array[object]        | body     | 是    | 资源拓扑, 资源类型的顺序必须操作注册时的顺序一致 |
 
 actions
 

diff --git a/saas/resources/apigateway/docs/zh/management_users_grade_managers.md.j2 b/saas/resources/apigateway/docs/zh/management_users_grade_managers.md.j2
@@ -3,10 +3,10 @@
 
 #### Parameters
 
-| 字段 |  类型 |是否必须  | 位置 |描述  |
-|--------|--------|--------|--------|--------|
-| system | string| 是 | body | 系统ID，即查询由某个系统创建的分级管理员列表 |
-| uesr_id | string | 是 | body | 用户ID，即用户名 |
+| 字段 |  类型 |是否必须  | 位置    |描述  |
+|--------|--------|--------|-------|--------|
+| system | string| 是 | query | 系统ID，即查询由某个系统创建的分级管理员列表 |
+| uesr_id | string | 是 | query | 用户ID，即用户名 |
 
 #### Response