OpenAPI-Specification
OpenAPI-Specification copied to clipboard
OAI
The OpenAPI Specification Repository
In 3.1.1 we added the `?` because it matched RFC6570 library behavior, but explained that sometimes you need to strip it. This is awkward, because the table is showing individual...
With PR #4647, these fields become obsolete and retained purely for compatibility. They have [numerous ambiguities and variable implementations](https://github.com/OAI/OpenAPI-Specification/issues/4659). They also MUST NOT be used alongside the newly added fields....
The Parameter, Header, and Media Type Objects all support both an `example` field (singular) and an `examples` field (plural) that uses Example Objects. The `example` field is equivalent to the...
@mikekistler noticed the text that (since at least 3.0) has said that examples outside of the Schema Object "override" examples inside of it, and questioned why it should be there....
These fields have usually been interpreted by us as requiring serialized values, but this is called into question on an (at least) annual basis ([2022](https://github.com/OAI/OpenAPI-Specification/issues/3041#issuecomment-1449051507), [2023](https://github.com/handrews) ([mostly on Slack](https://open-api.slack.com/archives/C1137F8HF/p1675197255857239)), [2024](https://github.com/OAI/OpenAPI-Specification/pull/3893),...
Creating this tracking issue for the tasks that need doing around the release. These are the pull requests we won't release without (other PRs may still merge via the normal...
## Weekly meetings happen on Thursdays at 9am - 10am Pacific This agenda gives visibility into discussion topics for the weekly Technical Developer Community (TDC) meetings. Sharing agenda items in...
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "github-actions[bot] avatar"){kind=avatar}
This pull request is automatically generated by GitHub action `schema-publish`. The `src/schemas/validation/*.yaml` files have changed and JSON files are automatically generated.
This pull request is automatically triggered by GitHub action `respec` in the OAI/Overlay-Specification repo. The `versions/*.md` files have changed, so the HTML files are automatically being regenerated.
![oai-spec-publisher[bot] avatar](https://avatars.githubusercontent.com/u/16343502?v=4 "oai-spec-publisher[bot] avatar"){kind=avatar}
This could be used to represent the version information of the described API. The current `version` field is oftentimes misunderstood and misused to represent the API version information. Having a...
