feat: OpenAPI 3.1 support (#8367)
- New top-level field - `webhooks`. This allows describing out-of-band webhooks that are available as part of the API. - New top-level field - `jsonSchemaDialect`. This allows defining of a default `$schema` value for Schema Objects - The Info Object has a new `summary` field. - The License Object now has a new `identifier` field for SPDX licenses. This `identifier` field is mutually exclusive with the `url` field. Either can be used in OpenAPI 3.1 definitions. - Components Object now has a new entry `pathItems`, to allow for reusable Path Item Objects to be defined within a valid OpenAPI document. - `License` and `Contact` components are now exported and available via `getComponent` - New version predicates and selectors for `isOpenAPI30` and `isOpenAPI31`. This avoids needing to change the usage of `isOAS3` selector. - New OAS3 components: `Webhooks` - New OAS3 wrapped components: `Info`, `License`
This commit is contained in:
@@ -1,16 +1,27 @@
|
||||
import React from "react"
|
||||
|
||||
export function isOpenAPI30(jsSpec) {
|
||||
const oasVersion = jsSpec.get("openapi")
|
||||
if (typeof oasVersion !== "string") {
|
||||
return false
|
||||
}
|
||||
return oasVersion.startsWith("3.0.") && oasVersion.length > 4
|
||||
}
|
||||
|
||||
export function isOpenAPI31(jsSpec) {
|
||||
const oasVersion = jsSpec.get("openapi")
|
||||
if (typeof oasVersion !== "string") {
|
||||
return false
|
||||
}
|
||||
return oasVersion.startsWith("3.1.") && oasVersion.length > 4
|
||||
}
|
||||
|
||||
export function isOAS3(jsSpec) {
|
||||
const oasVersion = jsSpec.get("openapi")
|
||||
if(typeof oasVersion !== "string") {
|
||||
return false
|
||||
}
|
||||
|
||||
// we gate against `3.1` because we want to explicitly opt into supporting it
|
||||
// at some point in the future -- KS, 7/2018
|
||||
|
||||
// starts with, but is not `3.0.` exactly
|
||||
return oasVersion.startsWith("3.0.") && oasVersion.length > 4
|
||||
return isOpenAPI30(jsSpec) || isOpenAPI31(jsSpec)
|
||||
}
|
||||
|
||||
export function isSwagger2(jsSpec) {
|
||||
|
||||
Reference in New Issue
Block a user