OpenAPI-Specification
OpenAPI-Specification copied to clipboard
The OpenAPI Specification Repository
I'm not currently a user of OpenAPI but a follower of standards initiatives like OpenBanking/FAPI where members claim that OpenAPI currently does not support JOSE (JSON Signature and Encryption) standards...
As part of a spec validation related research, I have run into some confusions in the OpenAPI v3.0.3 specification document [Parameter Object section](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#parameterObject), in particular the one shown below: ...
We occasionally see folks trying to use OAS with `multipart/mixed`, which does not support it. But it would not be hard to define a mapping along the lines of `multipart/form-data`...
This is a proposal to add support for [HTTP compression](https://en.wikipedia.org/wiki/HTTP_compression) to version 3.0 of the OpenAPI specification. **Rationale for this change** At present, there is no robust way to determine...
Hi, I recently came across an OpenAPI Spec file from a customer where some path-level parameters/responses/headers/schemas were defined through an internal reference, but having $ref pointing to a parameter/response/header/schema defined...
[RFC 9110 §14.6](https://www.rfc-editor.org/rfc/rfc9110.html#name-media-type-multipart-bytera) defines the `multipart/byteranges` media type for use in 206 (Partial Content) responses. We should see what, if anything, is needed to support it. Probably something involving the...
In the context of an [`operationId`](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#operationObject). the spec says: > The id [operationId] MUST be unique among all operations described in the API What is the definition of API in...
The draft [registry](http://spec.openapis.org/registry/) is built with [Jekyll collections](https://jekyllrb.com/docs/collections/). Each item in the collection, representing a registry entry, is a markdown file containing machine-readable properties in [YAML front matter](https://jekyllrb.com/docs/front-matter/), followed by...
We can't describe different templated name with same hierarchy. > Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical. But I can't...
The path template matching rules in the spec lead to confusion in several implementations of OpenAPI validators. https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#path-templating-matching Given the specification https://petstore3.swagger.io. What is the right result when a client...