Skip to content

Commit

Permalink
docs(filemanager): clarify docs on queries with and without []
Browse files Browse the repository at this point in the history
  • Loading branch information
mmalenic committed Oct 8, 2024
1 parent 2c8f931 commit 00fe478
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions lib/workload/stateless/stacks/filemanager/docs/API_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,9 +149,8 @@ or `bucket2`:
curl -H "Authorization: Bearer $TOKEN" "https://file.dev.umccr.org/api/v1/s3?bucket[]=bucket1&bucket[]=bucket2" | jq
```

Note that the extra `[]` is required in the query parameters to specify multiple keys with the same name. Multiple keys
are also supported on attributes. For example, the following finds records where the `portalRunId` is either `20240521aecb782`
or `20240521aecb783`:
Multiple keys are also supported on attributes. For example, the following finds records where the `portalRunId` is
either `20240521aecb782` or `20240521aecb783`:

```sh
curl --get -H "Authorization: Bearer $TOKEN" \
Expand All @@ -160,6 +159,10 @@ curl --get -H "Authorization: Bearer $TOKEN" \
"https://file.dev.umccr.org/api/v1/s3" | jq
```

Note that the extra `[]` is required in the query parameters to specify multiple keys with the same name. Specifying
multiple of the same key without `[]` results in an error. It is also an error to specify some keys with `[]` and some
without for keys with the same name.

## Updating records

As part of allowing filemanager to link and query on attributes, attributes can be updated using PATCH requests.
Expand Down

0 comments on commit 00fe478

Please sign in to comment.