Skip to content

Releases: OAI/OpenAPI-Specification

OAS 3.0.0-rc1 Released!

28 Apr 02:12
@webron webron
3.0.0-rc1
0686522
Compare
Choose a tag to compare
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 and default values are now string only (were any primitive).
  • 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 and examples fields have been reworked, alongside the Example Object. There is no longer examples field under the Schema Object. Where examples 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 to operationRef, its description is clarified as well.
  • The deprecated field under the Schema Object now defaults to false.
  • The flow field under the Security Scheme Object has been renamed to flows.
  • Request Body's required now defaults to false.
  • 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 or content 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

Assets 2
Loading

OAS 3.0.0-rc0 Released!

01 Mar 01:04
@webron webron
3.0.0-rc0
d232e6d
Compare
Choose a tag to compare
OAS 3.0.0-rc0 Released! Pre-release
Pre-release

We're happy to announce the release of the first Implementer's Draft of OAS 3.0.0, known as 3.0.0-rc0.

A lot of changes in this release, as a first one goes, so expect the change log to be updated. An initial list of changes, in no particular order:

  • Changed the versioning scheme of the spec.
  • Reusable definitions in the spec has been expanded and reorganized under the Components Object.
  • Added support for operation callbacks.
  • Added support for a new static linking between responses and operations.
  • Reworked parameters - removed formData parameters, added cookie parameters, changed body parameters to Request Body Objects as a separate entity.
  • Parameters now support complex types.
  • Responses support multiple media type specifications.
  • Reworked file support. Dropped file as a type, but provided better handling for file uploads and downloads.
  • Reworked security definitions to allow for support for more schemes.
  • Improved support for examples throughout the spec.
  • Added support for defining multiple servers hosting the API, including URL variables.

Check it out! https://github.com/OAI/OpenAPI-Specification/blob/3.0.0-rc0/versions/3.0.md

Our blog post contains more details of the process and next steps.

Assets 2
Loading