Skip to content

Commit d5fad83

Browse files
authored
Changes by create-pull-request action (#161)
2 parents 627ac66 + e0a99eb commit d5fad83

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/services/api.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@ Endpoints:
1919
[{"inboxPath":"requester_demo.org/data/file1.c4gh","fileStatus":"uploaded","createAt":"2023-11-13T10:12:43.144242Z"}]
2020
```
2121

22+
It is possible to limit the returned results by supplying a base path prefix in the query. In this case only files that have a path that starts with `submission-1` will be returned.
23+
24+
```bash
25+
curl -H "Authorization: Bearer $token" -X GET https://HOSTNAME/files?path_prefix=submission-1
26+
```
27+
2228
If the `token` is invalid, 401 is returned.
2329

2430
- `/datasets`
@@ -215,6 +221,12 @@ Admin endpoints are only available to a set of whitelisted users specified in th
215221
curl -H "Authorization: Bearer $token" -X GET https://HOSTNAME/users/submitter@example.org/files
216222
```
217223

224+
It is possible to limit the returned results by supplying a base path prefix in the query. In this case only files that have a path that starts with `submission-1` will be returned.
225+
226+
```bash
227+
curl -H "Authorization: Bearer $token" -X GET https://HOSTNAME/users/submitter@example.org/files?path_prefix=submission-1
228+
```
229+
218230
- Error codes
219231
- `200` Query execute ok.
220232
- `401` Token user is not in the list of admins.

0 commit comments

Comments
 (0)