openapi

How to define a property that can be string or null in OpenAPI (Swagger)?

by

This depends on the OpenAPI version. OpenAPI 3.1 Your example is valid in OpenAPI 3.1, which is fully compatible with JSON Schema 2020-12. type: – ‘null’ # Note the quotes around ‘null’ – string # same as type: [‘null’, string] The above is equivalent to: oneOf: – type: ‘null’ # Note the quotes around ‘null’ … Read more

How can I represent ‘Authorization: Bearer ‘ in a Swagger Spec (swagger.json)

by

Maybe this can help: swagger: ‘2.0’ info: version: 1.0.0 title: Bearer auth example description: > An example for how to use Bearer Auth with OpenAPI / Swagger 2.0. host: basic-auth-server.herokuapp.com schemes: – http – https securityDefinitions: Bearer: type: apiKey name: Authorization in: header description: >- Enter the token with the `Bearer: ` prefix, e.g. “Bearer … Read more