OAS 3.0.0-rc1 Released!
Pre-release
Pre-release
OAS 3.0.0-rc1 Change Log
Schema Changes
url
is now required under the Server Object.- Server Variable Object's
enum
anddefault
values are nowstring
only (were anyprimitive
). servers
under the Path Item Object and Operation Object has been fixed to be an array of Server Objects and not a single one.- The
example
andexamples
fields have been reworked, alongside the Example Object. There is no longerexamples
field under the Schema Object. Whereexamples
exist, 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. content
is now required under the Request Body Object.href
under the Link Object has been renamed tooperationRef
, its description is clarified as well.- The
deprecated
field under the Schema Object now defaults tofalse
. - The
flow
field under the Security Scheme Object has been renamed toflows
. - Request Body's
required
now defaults tofalse
. - Added
allowReserved
to the Encoding Property Object.
Descriptive Changes
termsOfService
now MUST be in the form of a URL.- all
description
fields now support CommonMark. - Clarified that specific response codes (
200
for example) take precedence over response ranges (2XX
for example). - Clarified that for Parameter Object, either
schema
orcontent
are required. pattern
under 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
null
not 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