fix(docs): Add/update API keys list
This commit is contained in:
parent
f2382ba8de
commit
fcc5214238
2 changed files with 64 additions and 9 deletions
62
markdown/dev/reference/backend/apikeys/list/en.md
Normal file
62
markdown/dev/reference/backend/apikeys/list/en.md
Normal file
|
@ -0,0 +1,62 @@
|
|||
---
|
||||
title: List API keys
|
||||
---
|
||||
|
||||
Lists existing API keys.
|
||||
|
||||
## Access control
|
||||
|
||||
- [Permission level](/reference/backend/rbac) `0` or higher is required to list API keys
|
||||
|
||||
## Endpoints
|
||||
|
||||
Listing API keys is possible via these endpoints:
|
||||
|
||||
| Method | Path | Authentication |
|
||||
| --------: | :--- | :------------- |
|
||||
| <Method get /> | `/apikeys/jwt` | [JSON Web Token](/reference/backend/authentication#jwt-authentication) |
|
||||
| <Method get /> | `/apikeys/key` | [API Key & Secret](/reference/backend/authentication#key-authentication) |
|
||||
|
||||
## Response status codes
|
||||
|
||||
Possible status codes for these endpoints are:
|
||||
|
||||
| Status code | Description |
|
||||
| ----------: | :---------- |
|
||||
| <StatusCode status="200"/> | success |
|
||||
| <StatusCode status="404"/> | API key not found |
|
||||
|
||||
## Response body
|
||||
|
||||
| Value | Type | Description |
|
||||
| ------------------- | -------- | ----------- |
|
||||
| `result` | `string` | `success` on success, and `error` on error |
|
||||
| `error` | `string` | Will give info on the nature of the error. Only set if an error occurred. |
|
||||
| `apikeys` | `Array`` | Array of API key strings |
|
||||
|
||||
## Example request
|
||||
|
||||
```js
|
||||
const keyInfo = await axios.get(
|
||||
'https://backend.freesewing.org/apikeys/jwt',
|
||||
{
|
||||
headers: {
|
||||
Authorization: `Bearer ${token}`
|
||||
}
|
||||
}
|
||||
)
|
||||
```
|
||||
|
||||
## Example response
|
||||
```200.json
|
||||
{
|
||||
"result": "success",
|
||||
"apikeys": {
|
||||
[
|
||||
"7ea12968-7758-40b6-8c73-75cc99be762b",
|
||||
"7ea12968-7758-40b6-8c73-39bc3b6707a9",
|
||||
"7ea12968-7758-40b6-8c73-97bb9901010d",
|
||||
],
|
||||
}
|
||||
}
|
||||
```
|
|
@ -32,7 +32,7 @@ delete local.response.body.regular.properties.secret
|
|||
// Paths
|
||||
export const paths = {}
|
||||
|
||||
// Create API key
|
||||
// List API keys or Create an API key
|
||||
paths['/apikeys/{auth}'] = {
|
||||
get: {
|
||||
...common,
|
||||
|
@ -55,14 +55,7 @@ paths['/apikeys/{auth}'] = {
|
|||
},
|
||||
}),
|
||||
},
|
||||
401: response.status['401'],
|
||||
403: {
|
||||
...response.status['403'],
|
||||
description:
|
||||
response.status['403'].description +
|
||||
errorExamples(['accountStatusLacking', 'insufficientAccessLevel']),
|
||||
},
|
||||
500: response.status['500'],
|
||||
404: response.status['404'],
|
||||
},
|
||||
},
|
||||
post: {
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue