Skip to content

Commit

Permalink
[api] clarify documentation about error codes
Browse files Browse the repository at this point in the history
  • Loading branch information
jbygdell committed Jul 31, 2024
1 parent 5da2bae commit 224aca7
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions sda/cmd/api/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:
Expand All @@ -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:
Expand All @@ -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:
Expand All @@ -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`
Expand All @@ -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.

0 comments on commit 224aca7

Please sign in to comment.