OpenAPI-Specification icon indicating copy to clipboard operation
OpenAPI-Specification copied to clipboard

The OpenAPI Specification Repository

Results 476 OpenAPI-Specification issues
Sort by recently updated
recently updated
newest added

Just noticed there's no information about mutualTLS in the spec other than that it exists as a valid type.

How about adding a not composition example to the spec?

For large API structures, it makes sense to have API and definitions split out into multiple files for reuse and readability. Both security and securityDefinitions seem like properties that would...

$ref

Documenting APIs often depend on multiple external factors - functional and non-functional aspects, change notes, governance, strategy, many more - and a single externalDocs reference is often insufficient, especially in...

enhancement
metadata
re-use: ref-group-combine

I'm looking at various options to "upgrade" a simple API ([HTTP POST of CloudEvents](https://github.com/cloudevents/spec/blob/v1.0/http-protocol-binding.md)) to allow clients and servers to be able to extend into more complex OpenAPI space (e.g....

discovery

would it make sense to recommend best practices for how an API should make its OpenAPI description (and potentially additional documentation) discoverable? we don't know how exactly an API is...

For discriminators, there should be a feature like propertyType which will enable us to control discriminators in a better way.

In the main openapi.yaml file I need to do something like: ```yaml tags: - $ref: "./customers.yaml#/tags/0" ``` This should be a valid JSON pointer if I'm not mistaken. Unfortunately, AFAIK...

### Parameters for Media Types Media Types can support parameters. Yet, to work with them in OpenAPI, one must define them statically against each media type. This has the unfortunate...

media and encoding
request matching
headers

I was wondering if there is metaplan to formalize bundling of OAS definitions as well. Ben Hutton and Mike Ralphson did a great job of formalizing JSON Schema 2020-12 in...