OAS 3.0.0-rc1 Released!
Pre-release
Pre-release
OAS 3.0.0-rc1 Change Log
Schema Changes
urlis now required under the Server Object.- Server Variable Object's
enumanddefaultvalues are nowstringonly (were anyprimitive). serversunder the Path Item Object and Operation Object has been fixed to be an array of Server Objects and not a single one.- The
exampleandexamplesfields have been reworked, alongside the Example Object. There is no longerexamplesfield under the Schema Object. Whereexamplesexist, they are now a map of named examples with additional metadata for each example. The Example Object now has defined fields and is not free-form. contentis now required under the Request Body Object.hrefunder the Link Object has been renamed tooperationRef, its description is clarified as well.- The
deprecatedfield under the Schema Object now defaults tofalse. - The
flowfield under the Security Scheme Object has been renamed toflows. - Request Body's
requirednow defaults tofalse. - Added
allowReservedto the Encoding Property Object.
Descriptive Changes
termsOfServicenow MUST be in the form of a URL.- all
descriptionfields now support CommonMark. - Clarified that specific response codes (
200for example) take precedence over response ranges (2XXfor example). - Clarified that for Parameter Object, either
schemaorcontentare required. patternunder the Schema Object now specifies the regex flavor.- Added header restrictions. "Accept", "Content-Type", "Authorization" header paramters and "Content-Type" response headers will now be ignored.
- Referenced a specific version of supported CommonMark.
- Added clarifications to
nullnot being a type (as opposed to a value).
Document Changes
- ToC has been updated to reflect changes.
- Fixed various anchors in the document.
- Various examples have been fixed.
Check it out! https://github.com/OAI/OpenAPI-Specification/blob/3.0.0-rc1/versions/3.0.md