-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
24 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -29,11 +29,11 @@ Admin endpoints are only available to a set of whitelisted users specified in th | |
| - accepts `POST` requests with JSON data with the format: `{"filepath": "</PATH/TO/FILE/IN/INBOX>", "user": "<USERNAME>"}` | ||
| - triggers the ingestion of the file. | ||
|
|
||
| - Error codes | ||
| - `200` Query execute ok. | ||
| - `400` Error due to bad payload i.e. wrong `user` + `filepath` combination. | ||
| - `401` Token user is not in the list of admins. | ||
| - `500` Internal error due to DB or MQ failures. | ||
| - Error codes | ||
| - `200` Query execute ok. | ||
| - `400` Error due to bad payload i.e. wrong `user` + `filepath` combination. | ||
| - `401` Token user is not in the list of admins. | ||
| - `500` Internal error due to DB or MQ failures. | ||
|
|
||
| Example: | ||
|
|
||
|
|
@@ -45,11 +45,11 @@ Admin endpoints are only available to a set of whitelisted users specified in th | |
| - accepts `POST` requests with JSON data with the format: `{"accession_id": "<FILE_ACCESSION>", "filepath": "</PATH/TO/FILE/IN/INBOX>", "user": "<USERNAME>"}` | ||
| - assigns accession ID to the file. | ||
|
|
||
| - Error codes | ||
| - `200` Query execute ok. | ||
| - `400` Error due to bad payload i.e. wrong `user` + `filepath` combination. | ||
| - `401` Token user is not in the list of admins. | ||
| - `500` Internal error due to DB or MQ failures. | ||
| - Error codes | ||
| - `200` Query execute ok. | ||
| - `400` Error due to bad payload i.e. wrong `user` + `filepath` combination. | ||
| - `401` Token user is not in the list of admins. | ||
| - `500` Internal error due to DB or MQ failures. | ||
|
|
||
| Example: | ||
|
|
||
|
|
@@ -77,11 +77,11 @@ Admin endpoints are only available to a set of whitelisted users specified in th | |
| - accepts `POST` requests with the dataset name as last part of the path` | ||
| - releases a dataset so that it can be downloaded. | ||
| - Error codes | ||
| - `200` Query execute ok. | ||
| - `400` Error due to bad payload. | ||
| - `401` Token user is not in the list of admins. | ||
| - `500` Internal error due to DB or MQ failures. | ||
| - Error codes | ||
| - `200` Query execute ok. | ||
| - `400` Error due to bad payload. | ||
| - `401` Token user is not in the list of admins. | ||
| - `500` Internal error due to DB or MQ failures. | ||
| Example: | ||
|
|
@@ -99,25 +99,25 @@ Admin endpoints are only available to a set of whitelisted users specified in th | |
| curl -H "Authorization: Bearer $token" -X GET https://HOSTNAME/users | ||
| ``` | ||
|
|
||
| - Error codes | ||
| - `200` Query execute ok. | ||
| - `401` Token user is not in the list of admins. | ||
| - `500` Internal error due to DB failure. | ||
| - Error codes | ||
| - `200` Query execute ok. | ||
| - `401` Token user is not in the list of admins. | ||
| - `500` Internal error due to DB failure. | ||
|
|
||
| - `/users/:username/files` | ||
| - accepts `GET` requests` | ||
| - Returns all files (that is not part of a dataset) for a user with active uploads as a JSON array | ||
| - Returns all files (that are not part of a dataset) for a user with active uploads as a JSON array | ||
| Example: | ||
| ```bash | ||
| curl -H "Authorization: Bearer $token" -X GET https://HOSTNAME/users/[email protected]/files | ||
| ``` | ||
|
|
||
| - Error codes | ||
| - `200` Query execute ok. | ||
| - `401` Token user is not in the list of admins. | ||
| - `500` Internal error due to DB failure. | ||
| - Error codes | ||
| - `200` Query execute ok. | ||
| - `401` Token user is not in the list of admins. | ||
| - `500` Internal error due to DB failure. | ||
|
|
||
| #### Configure Admin users | ||
|
|
||
|
|
||