Forum Discussion

Wicia's avatar
Wicia
New Contributor
4 years ago
Solved

Add Upload button for OpenAPI 2.0 file as Octet-Stream

Context I am using OpenAPI ver 2.0 I have API which consumes application/octet-stream (Java InputStream) Issue In OpenAPI ver 2.0 I can only set input type as multipart/form-data (link) to have...
java
OpenApi
swagger
upload
  • HKosova's avatar
    HKosova
    4 years ago

    Not out of the box. You can try forking Swagger UI and implementing this non-standard functionality yourself. But the proper solution is to use OpenAPI 3.0. If you write the API definition manually (rather than generate it from code), there are OpenAPI 2.0-to-3.0 converters to help you with the migration.

HKosova's avatar
HKosova
SmartBear Alumni (Retired)
4 years ago

OpenAPI 2.0 does not support application/octet-stream in the request body, it only supports file upload via multipart/form-data.

 

To define application/octet-stream request bodies you need OpenAPI 3.0:

 

openapi: 3.0.0
...
paths:
  /something:
    post:
      requestBody:
        required: true
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary

 

See also: File upload in OpenAPI 3.0

  • Wicia's avatar
    Wicia
    New Contributor
    4 years ago

    And there is no solution which could cause that we will be able to upload files as octet-stream using OpenAPI 2.0 and some component to attach file? ğŸ™‚

    • HKosova's avatar
      HKosova
      SmartBear Alumni (Retired)
      4 years ago

      Not out of the box. You can try forking Swagger UI and implementing this non-standard functionality yourself. But the proper solution is to use OpenAPI 3.0. If you write the API definition manually (rather than generate it from code), there are OpenAPI 2.0-to-3.0 converters to help you with the migration.