Skip to content

docs(admin-api): clarify Credential name field description and fix typos #13837

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.

Sign up for GitHub

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

Open
okaybase wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(admin-api): clarify Credential name field description and fix typos #13837

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions docs/en/latest/admin-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -917,17 +917,17 @@ Credential resource request address：/apisix/admin/consumers/{username}/credent

| Method | Request URI | Request Body | Description |
| ------ |----------------------------------------------------------------|--------------|------------------------------------------------|
| GET | /apisix/admin/consumers/{username}/credentials | NUll | Fetches list of all credentials of the Consumer |
| GET | /apisix/admin/consumers/{username}/credentials/{credential_id} | NUll | Fetches the Credential by `credential_id` |
| PUT | /apisix/admin/consumers/{username}/credentials/{credential_id} | {...} | Create or update a Creddential |
| DELETE | /apisix/admin/consumers/{username}/credentials/{credential_id} | NUll | Delete the Credential |
| GET | /apisix/admin/consumers/{username}/credentials | NULL | Fetches list of all credentials of the Consumer |
| GET | /apisix/admin/consumers/{username}/credentials/{credential_id} | NULL | Fetches the Credential by `credential_id` |
| PUT | /apisix/admin/consumers/{username}/credentials/{credential_id} | {...} | Create or update a Credential |
| DELETE | /apisix/admin/consumers/{username}/credentials/{credential_id} | NULL | Delete the Credential |

### Request Body Parameters

| Parameter | Required | Type | Description | Example |
| ----------- |-----| ------- |------------------------------------------------------------|-------------------------------------------------|
| plugins | False | Plugin | Auth plugins configuration. | |
| name | False | Auxiliary | Identifier for the Credential. | credential_primary |
| name | False | Auxiliary | Name of the Consumer Credential. | credential_primary |
| desc | False | Auxiliary | Description of usage scenarios. | credential xxxx |
| labels | False | Match Rules | Attributes of the Credential specified as key-value pairs. | {"version":"v2","build":"16","env":"production"} |

Expand Down
Loading