- Minimal mandatory fields
- Partially supported:
- readOnly and writeOnly properties
- Webhooks support
We support all major versions from Swagger (OpenAPI v2), OpenAPI v3 and OpenAPI v3.1. This pages describes some specificities related to our support for this specification.
Minimal mandatory fields #
Bump.sh needs to receive at least these fields to generate a REST documentation
|define which version of the specification you want to use. Use the
swagger key for v2 and
openapi for the v3+. E.g.
|General information about your API
|The title of the API
|The version of the API document
securitySchemes (V3) /
securityDefinitions (V2) #
We support OpenAPI
securitySchemes property (
securityDefinitions with openAPI v2) with these authentication type values:
We do not support
mutualTLS. To describe a
mutualTLS authentication method, please use the
x-topics property for now.
readOnly and writeOnly properties #
JSON Schema provides the possibility to declare a property as read or write only. Read more in the JSON Schema section of this documentation.
Webhooks support #
You can use the
webhooks field (introduced in OpenAPI 3.1) to define the API webhook payloads. Please read to the dedicated documentation page for more information.