From 6dac0083cb994cbcc1e99dd856acce47c0bb2faf Mon Sep 17 00:00:00 2001 From: Joakim Bygdell Date: Wed, 31 Jul 2024 14:05:59 +0200 Subject: [PATCH] [api] clarify documentation about error codes --- sda/cmd/api/api.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/sda/cmd/api/api.md b/sda/cmd/api/api.md index 6995db444..636cc46d0 100644 --- a/sda/cmd/api/api.md +++ b/sda/cmd/api/api.md @@ -32,7 +32,7 @@ Admin endpoints are only available to a set of whitelisted users specified in th - Error codes - `200` Query execute ok. - `400` Error due to bad payload i.e. wrong `user` + `filepath` combination. - - `401` User is not in the list of admins. + - `401` Token user is not in the list of admins. - `500` Internal error due to DB or MQ failures. Example: @@ -48,7 +48,7 @@ Admin endpoints are only available to a set of whitelisted users specified in th - Error codes - `200` Query execute ok. - `400` Error due to bad payload i.e. wrong `user` + `filepath` combination. - - `401` User is not in the list of admins. + - `401` Token user is not in the list of admins. - `500` Internal error due to DB or MQ failures. Example: @@ -64,7 +64,7 @@ Admin endpoints are only available to a set of whitelisted users specified in th - Error codes - `200` Query execute ok. - `400` Error due to bad payload. - - `401` User is not in the list of admins. + - `401` Token user is not in the list of admins. - `500` Internal error due to DB or MQ failures. Example: @@ -80,7 +80,7 @@ Admin endpoints are only available to a set of whitelisted users specified in th - Error codes - `200` Query execute ok. - `400` Error due to bad payload. - - `401` User is not in the list of admins. + - `401` Token user is not in the list of admins. - `500` Internal error due to DB or MQ failures. Example: @@ -101,7 +101,7 @@ Admin endpoints are only available to a set of whitelisted users specified in th - Error codes - `200` Query execute ok. - - `401` User is not in the list of admins. + - `401` Token user is not in the list of admins. - `500` Internal error due to DB failure. - `/users/:username/files` @@ -116,5 +116,5 @@ Admin endpoints are only available to a set of whitelisted users specified in th - Error codes - `200` Query execute ok. - - `401` User is not in the list of admins. + - `401` Token user is not in the list of admins. - `500` Internal error due to DB failure.