-
Notifications
You must be signed in to change notification settings - Fork 9.1k
OpenAPI Specification 3.1-RC0 Changelog #2223
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Comments
|
I'm telling you, those damn foreigners... |
Probably should call out these specifically (the first two need PRs which I can do today/tomorrow if needed, the last two are covered by PR #2200):
Also, for the RC, probably worth noting that the final release will correspond to the next JSON Schema draft, including these changes which are not breaking relative to OAS 3 even though they are breaking relative to draft 2019-09:
|
Also if we go to 4.0, do we want to drop |
Wouldn't you usually deprecate nullable in 3.1 and then remove it in 4.0? |
Closing as |
This ticket gives everyone the opportunity to look at the changelog for the upcoming release. Please review the content and add anything you think might be missing.
The part about the JSON Schema draft is a bit lacking as we might push in some different changes before the release. Anyone who wants to add a summary for it is more than welcome.
Changelog
Additions
webhooks
. This allows describing out-of-band webhooks that are available as part of the API.Info Object
has a newsummary
field.License Object
now has a newidentifier
field for SPDX licenses.Components Object
now has a new entrypathItems
, to allow for reusablePath Item Object
s to be defined within a valid OpenAPI document.Extended Functionality
null
.Request Body
only in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for. While allowed in other methods, it is not recommended.object
type
forspaceDelimited
andpipeDelimited
style
values.Encoding Object
now supportsstyle
,explode
andallowReserved
formultipart/form-data
media type as well.webhooks
support, expressions in theCallback Object
can now also referencePath Item Object
s.Reference Object
,summary
anddescription
fields can now be overridden.Schema Object
is now fully compliant with JSON Schema draft 2019-09 (see JSON Schema Core and JSON Schema Validation).Discriminator Object
can now be extended with Specification Extensions.mutualTLS
) as a security scheme.Changes
paths
,components
orwebhooks
to exist at the top level. While previous versions requiredpaths
, now a valid OpenAPI Document can describe only webhooks, or even only reusable components. Thus, an OpenAPI Document no longer necessarily describes an API.$ref
is inherently part of theSchema Object
and has its own defined behavior.x-oas-
are now reserved for the OpenAPI Initiative.Clarifications
OpenAPI Document
to reflect that a document no longer must describe paths, but can describe either paths, webhooks, components or any combination of them.The text was updated successfully, but these errors were encountered: