Commit c84fdcf
authored
fix: rectify "GET .../files" response schema (#249)
Fixes #248
### Description
Replaced response schema for [`GET .../files`](https://github.com/ga4gh/tool-registry-service-schemas/blob/1dd4bf806f98fa2e3d224d1976f6179de5cd46d6/openapi/openapi.yaml#L322-L370) with content type 'application/zip`.
Previously:
```yaml
application/zip:
schema:
type: array
items:
$ref: "#/components/schemas/ToolFile"
```
Proposed:
```yaml
application/zip:
schema:
type: string
format: binary
```
### Motivation
From the [Swagger UI documentation] on file uploads:
> Files use a `type: string` schema with `format: binary` or `format: base64`, depending on how the file contents will be encoded.
Some other references to relevant discussions and uses of `type: string` and `format: binary` for representing binary file objects in request body or response schemas:
- https://spec.openapis.org/oas/v3.0.3#considerations-for-file-uploads
- swagger-api/swagger-ui#5636
- https://azure.github.io/autorest/openapi/howto/binary-payload.html
- https://docs.visionlabs.ai/luna/v.5.24.1/ServiceManuals/APIDevelopmentManual/openapi_spec.html
- https://hyperfoil.io/docs/restapi.html1 parent ee0afe9 commit c84fdcf
1 file changed
+2
-3
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
357 | 357 | | |
358 | 358 | | |
359 | 359 | | |
360 | | - | |
361 | | - | |
362 | | - | |
| 360 | + | |
| 361 | + | |
363 | 362 | | |
364 | 363 | | |
365 | 364 | | |
| |||
0 commit comments