From f9b60ea78853ea81c825fe3cc011934aebe412e1 Mon Sep 17 00:00:00 2001 From: Xiaoyan Rao <270668624@qq.com> Date: Tue, 3 Sep 2024 10:46:24 +0800 Subject: [PATCH] docs(admins): update the admin's API. --- api-specs/Gateway-EE/latest/kong-ee.yaml | 41 +++++++++++++----------- 1 file changed, 23 insertions(+), 18 deletions(-) diff --git a/api-specs/Gateway-EE/latest/kong-ee.yaml b/api-specs/Gateway-EE/latest/kong-ee.yaml index 32486123856c..04d112225a4f 100644 --- a/api-specs/Gateway-EE/latest/kong-ee.yaml +++ b/api-specs/Gateway-EE/latest/kong-ee.yaml @@ -194,6 +194,13 @@ components: type: string example: 30b4edb7-0847-4f65-af90-efbed8b0161f description: The license's unique ID. + admin_id_or_name: + schema: + type: string + name: name_or_id + in: path + required: true + description: The admin’s username or ID workspace_id_or_name: name: workspace_id_or_name in: path @@ -12258,12 +12265,7 @@ paths: - admins '/admins/{name_or_id}': parameters: - - schema: - type: string - name: name_or_id - in: path - required: true - description: The admin’s username or ID. + - $ref: '#/components/parameters/admin_id_or_name' get: summary: Retrieve an Admin tags: @@ -12360,12 +12362,7 @@ paths: description: Delete an admin by specifying the admin's username or ID. '/admins/{name_or_id}/roles': parameters: - - schema: - type: string - name: name_or_id - in: path - required: true - description: The admin’s username or ID + - $ref: '#/components/parameters/admin_id_or_name' get: summary: List an Admin’s Roles tags: @@ -12513,12 +12510,7 @@ paths: description: Delete an admin's roles by passing a comma-separated string of names of specific roles to remove from an admin. '/admins/{name_or_id}/workspaces': parameters: - - schema: - type: string - name: name_or_id - in: path - required: true - description: The admin’s username or ID + - $ref: '#/components/parameters/admin_id_or_name' get: summary: List an Admin’s Workspaces tags: @@ -12530,6 +12522,19 @@ paths: $ref: '#/components/responses/HTTP401Error' operationId: get-admins-name_or_id-workspaces description: Return workspaces associated with an admin. + '/admins/{name_or_id}/workspaces/{workspaces}': + parameters: + - $ref: '#/components/parameters/admin_id_or_name' + - $ref: '#/components/parameters/workspace_id_or_name' + patch: + summary: Update the admin's belong workspace. + tags: + - admins + responses: + '200': + $ref: '#/components/responses/workspace-response' + operationId: update-admins-name_or_id-belong_workspaces + description: Update the admin's belong workspace. /groups: get: summary: List Groups