Open R4wizard opened 4 years ago
Hey @R4wizard it's great to see you've started on this! Is there anything blocking your progress that I can help with?
I've got a few handy links here which might help, for example some articles showing off the differences between OpenAPI v3.0 and v3.1.
Here are some example files which can make for handy pass/fail test cases:
https://github.com/Mermade/openapi3-examples/tree/master/3.1
If you're looking for the JSON Schema that defines a valid OpenAPI document, that'll be right over here:
https://github.com/OAI/OpenAPI-Specification/tree/main/schemas/v3.1
Lmk if there's anything else. 👍🏻
OAS 3.1.0-rc0 Released!
view OAI changelog on GitHub
Additions
webhooks
. This allows describing out-of-band webhooks that are available as part of the API.summary
field.identifier
field for SPDX licenses.pathItems
, to allow for reusablePath Item Objects
to be defined within a valid OpenAPI document.Extended Functionality
null
.object
type
forspaceDelimited
andpipeDelimited
style
values.style
,explode
andallowReserved
formultipart/form-data
media type as well.webhooks
support, expressions in theCallback Object
can now also referencePath Item Object
s.summary
anddescription
fields can now be overridden.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.format
is now not validated by default.Breaking changes
nullable
keyword has been removed from theSchema Object
(null
can be used as a type value).exclusiveMaximum
andexclusiveMinimum
cannot acceptboolean
values (following JSON Schema).required
andreadOnly
/writeOnly
in relation to requests and responses.format
(whetherbyte
,binary
, orbase64
) is no longer used to describe file payloads. As part of JSON Schema compliance, nowcontentEncoding
andcontentMediaType
can be used for such specification.Clarifications