| title | description | layout |
|---|---|---|
Home |
HTML Spec. and extensible registry |
default |
This site contains the authoritative HTML renderings of the OpenAPI Initiative's specifications and extension registries, as well as official (but non-normative) schemas for those specifications that provide them.
Please see the Learn OpenAPI site for additional documentation and examples, and the OpenAPI Tooling site for community-provided lists of tools implementing the specifications.
{% include specification-version-list.md specification="arazzo" %}
{% include specification-version-list.md specification="oas" %}
- [v2.0]({{ site.baseurl }}/oas/v2.0.html)
{% include specification-version-list.md specification="overlay" %}
The Registry Page includes documentation as well as API and RSS access for all registries
Registry shortcuts: {% for registry in site.collections %}{% unless registry.hidden %}
- {{ registry.name }}{% endunless %}{% endfor %}
Note that while schemas can catch many errors, they are not guaranteed to catch all specification violations. In the event of a disagreement between the schemas and the corresponding specificaton text, the specification text is presumed to be correct.
{% include schema-iteration-list.md specification="arazzo" %}
Note that the OAS 3.1 schema/YYYY-MM-DD schema does not validate the Schema Object, as it makes no assumptions about the JSON Schema dialect in use. The OAS 3.1 schema-base/YYYY-MM-DD schema does validate the Schema Object, and requires that if jsonSchemaDialect or $schema are present, that they use the appropriate dialect/YYYY-MM-DD. The name schema-base comes from the JSON Schema dialect including the OAS extensions being referred to as the "base dialect" in the specification.
See issue #4147 for discussion of other possible JSON Schema dialect options, issue #4152 for programmatic access to the latest schemas, and issue #4141 for discussions on possibly providing linting schemas that could catch likely problems that do not directly violate the specification.
{% include schema-iteration-list.md specification="oas" %}
{% include schema-iteration-list.md specification="overlay" %}