Vikunja
/
api
mirror of https://kolaente.dev/vikunja/api.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

fix(docs): clarify error codes in swagger docs 

Resolves https://kolaente.dev/vikunja/api/issues/1518
This commit is contained in:
kolaente 2023-05-30 21:37:40 +02:00
parent 8c3ef34f75
commit d68338b649
No known key found for this signature in database
GPG Key ID: F40E70337AB24C9B
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
pkg/routes/routes.go
View File

@ -24,6 +24,9 @@
// @description # Rights
// @description All endpoints which return a single item (project, task, etc.) - no array - will also return a `x-max-right` header with the max right the user has on this item as an int where `0` is `Read Only`, `1` is `Read & Write` and `2` is `Admin`.
// @description This can be used to show or hide ui elements based on the rights the user has.
// @description # Errors
// @description All errors have an error code and a human-readable error message in addition to the http status code. You should always check for the status code in the response, not only the http status code.
// @description Due to limitations in the swagger library we're using for this document, only one error per http status code is documented here. Make sure to check the [error docs](https://vikunja.io/docs/errors/) in Vikunja's documentation for a full list of available error codes.
// @description # Authorization
// @description **JWT-Auth:** Main authorization method, used for most of the requests. Needs `Authorization: Bearer <jwt-token>`-header to authenticate successfully.
// @description