diff --git a/lib/workload/stateless/stacks/filemanager/docs/API_GUIDE.md b/lib/workload/stateless/stacks/filemanager/docs/API_GUIDE.md index 28fd8e07d..468b51c09 100644 --- a/lib/workload/stateless/stacks/filemanager/docs/API_GUIDE.md +++ b/lib/workload/stateless/stacks/filemanager/docs/API_GUIDE.md @@ -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" \ @@ -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.