Skip to content
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time

OpenAPI Support

The following document contains the list of OpenAPI features that are supported in the parser per object type.

Key:

Status
Full Support
Partial Support ~
Unsupported

OpenAPI Object

Field Name Support
openapi
info
servers
paths ~
components ~
security
tags
externalDocs

Info Object

Field Name Support
title
description
termsOfService
contact
license
version

Contact Object

Field Name Support
name
url
email

License Object

Field Name Support
name
url

Server Object

Field Name Support
url
description
variables

Server Variable Object

Field Name Support
enum
default
description

Paths Object

Field Name Support
/{path} ~

Path Item Object

Field Name Support
summary
description
get ~
put ~
post ~
delete ~
options ~
head ~
patch ~
trace ~
servers
parameters ~

Operation Object

Field Name Support
tags
summary
description
externalDocs
operationId
parameters ~
requestBody
responses ~
callbacks
deprecated
security
servers

Parameter Object

Field Name Support
name
in ~
description
required
deprecated
allowEmptyValue

Serialisation Rules

Field Name Support
style
explode ~
allowReserved
schema ~ (minimal)
example
examples

Parameter Location

Location Support
path
query
header
cookie

Request Body Object

Location Support
description
content
required

Responses Object

Field Name Support
default
HTTP Status Code ~

HTTP Status Code ranges are not currently supported.

Response Object

Field Name Support
description
headers ~
content ~
links

Media Type Object

Field Name Support
schema
example
examples ~
encoding

Components Object

See #81 to track referencing support.

Field Name Support
schemas
responses
parameters
examples
requestBodies
headers ~
securitySchemes ~
links
callbacks

Schema Object

Field Name Support
type
enum
encoding
title
multipleOf
maximum
exclusiveMaximum
minimum
exclusiveMinimum
maxLength
minLength
pattern
maxItems
minItems
uniqueItems
maxProperties
minProperties
required
allOf
oneOf ~
anyOf
not
items
properties
additionalProperties
description
format
default
nullable
discriminator
readOnly
writeOnly
xml
externalDocs
example
deprecated

Header Object

Field Name Support
description
required
deprecated
allowEmptyValue

Security Scheme Object

See #329 to track things left to do.

Field Name Support
type ~
description
name
in
scheme ~
bearerFormat
flows
openIdConnectUrl

Security Scheme Type

Field Name Support
apiKey
http
oauth2
openIdConnect

Example Object

Field Name Support
summary
description
value
externalValue