From d68338b64932772496e55401d6dc1e4889bb685e Mon Sep 17 00:00:00 2001 From: kolaente Date: Tue, 30 May 2023 21:37:40 +0200 Subject: [PATCH] fix(docs): clarify error codes in swagger docs Resolves https://kolaente.dev/vikunja/api/issues/1518 --- pkg/routes/routes.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/pkg/routes/routes.go b/pkg/routes/routes.go index 03488dd24..a232fa32e 100644 --- a/pkg/routes/routes.go +++ b/pkg/routes/routes.go @@ -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 `-header to authenticate successfully. // @description