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(admins): update the admin's API. #7855

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
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
41 changes: 23 additions & 18 deletions api-specs/Gateway-EE/latest/kong-ee.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand All @@ -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
Expand Down
Loading