Permalink
2843dfd Feb 11, 2019
2 contributors

Users who have contributed to this file

@kylef @klokane
211 lines (175 sloc) 4.5 KB

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

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
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 https://github.com/apiaryio/api-elements.js/issues/81 to track referencing support.

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

Schema Object

Field Name Support
type
enum
examples
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