Skip to content

Commit

Permalink
fix: rectify "GET .../files" response schema
Browse files Browse the repository at this point in the history
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.html
  • Loading branch information
uniqueg authored May 21, 2024
1 parent 1dd4bf8 commit 3320e21
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions openapi/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -357,9 +357,8 @@ paths:
$ref: "#/components/schemas/ToolFile"
application/zip:
schema:
type: array
items:
$ref: "#/components/schemas/ToolFile"
type: string
format: binary
"404":
description: The tool can not be output in the specified type.
content:
Expand Down

0 comments on commit 3320e21

Please sign in to comment.