empayre/fleet
14
0
Fork 0
mirror of https://github.com/empayre/fleet.git synced 2024-11-06 08:55:24 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add example errors to api docs for login (#13941)

Browse Source
This commit is contained in:
George Karr 2023-09-26 10:33:35 -05:00 committed by GitHub
parent de4d76d09b
commit 68ac65f461
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 36 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/REST API/rest-api.md
View File

@ -101,6 +101,42 @@ Authenticates the user with the specified credentials. Use the token returned fr
}
```
##### Authentication failed
`Status: 401 Unauthorized`
```json
{
"message": "Authentication failed",
"errors": [
{
"name": "base",
"reason": "Authentication failed"
}
],
"uuid": "1272014b-902b-4b36-bcdb-75fde5eac1fc"
}
```
##### Too many requests / Rate limiting
`Status: 429 Too Many Requests`
`Header: retry-after: N`
> This response includes a header `retry-after` that indicates how many more seconds you are blocked before you can try again.
```json
{
"message": "limit exceeded, retry after: Ns",
"errors": [
{
"name": "base",
"reason": "limit exceeded, retry after: Ns"
}
]
}
```
---
### Log out