Chocobozzz/PeerTube
1
0
Fork 0
mirror of https://github.com/Chocobozzz/PeerTube.git synced 2024-09-20 01:47:21 +03:00
Code Issues Projects Releases Wiki Activity

explicit error formatting variant in openapi spec

Browse Source
This commit is contained in:
Rigel Kent 2021-05-11 01:18:02 +02:00
parent b8375da931
commit de3876b815
No known key found for this signature in database
GPG Key ID: 5E53E96A494E452F
1 changed files with 16 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
support/doc/api/openapi.yaml
View File

@ -39,12 +39,25 @@ info:
The API uses standard HTTP status codes to indicate the success or failure The API uses standard HTTP status codes to indicate the success or failure
of the API call. The body of the response will be JSON in the following of the API call. The body of the response will be JSON in the following
format. formats.
``` ```
{ {
"code": "unauthorized_request", // example inner error code "error": "Account not found" // error debug message
"error": "Token is invalid." // example exposed error message }
```
Some errors benefit from a more detailed message:
```
{
"errors": {
"id": { // where 'id' is the name of the parameter concerned by the error.
"value": "a117eb-c6a9-4756-bb09-2a956239f", // value that triggered the error.
"msg": "Should have an valid id", // error debug message
"param": "id",
"location": "params" // 'params', 'body', 'header', 'query' or 'cookies'
}
}
} }
``` ```