The list below is organized like the OpenAPI Specification 3.1.x reference. Types that have OpenAPIKit representations are checked off. Types that have different names in OpenAPIKit than they do in the specification have their OpenAPIKit names in parenthesis.
For more information on the OpenAPIKit types, see the full type documentation.
- OpenAPI Object (
OpenAPI.Document
) - Info Object (
OpenAPI.Document.Info
) - Contact Object (
OpenAPI.Document.Info.Contact
) - License Object (
OpenAPI.Document.Info.License
) - Server Object (
OpenAPI.Server
) - Server Variable Object (
OpenAPI.Server.Variable
) - Components Object (
OpenAPI.Components
) - Paths Object (
OpenAPI.PathItem.Map
) - Path Item Object (
OpenAPI.PathItem
) - Operation Object (
OpenAPI.Operation
) - External Document Object (
OpenAPI.ExternalDocumentation
) - Parameter Object (
OpenAPI.Parameter
) - Request Body Object (
OpenAPI.Request
) - Media Type Object (
OpenAPI.Content
) - Encoding Object (
OpenAPI.Content.Encoding
) - Responses Object (
OpenAPI.Response.Map
) - Response Object (
OpenAPI.Response
) - Callback Object
- Example Object (
OpenAPI.Example
) - Link Object
- Header Object (
OpenAPI.Header
) - Tag Object (
OpenAPI.Tag
) - Reference Object (
OpenAPI.Reference
) - Schema Object (
JSONSchema
) - Discriminator Object (
OpenAPI.Discriminator
) - XML Object (
OpenAPI.XML
) - Security Scheme Object (
OpenAPI.SecurityScheme
) - OAuth Flows Object (
OpenAPI.OauthFlows
) - OAuth Flow Object (
OpenAPI.OauthFlows.*
) - Security Requirement Object (
OpenAPI.Document.SecurityRequirement
)
- openapi (
openAPIVersion
) - info
- jsonSchemaDialect
- servers
- paths
- webhooks
- components
- security
- tags
- externalDocs
- specification extensions (
vendorExtensions
)
- title
- summary
- description
- termsOfService
- contact
- license
- version
- specification extensions (
vendorExtensions
)
- name
- url
- specification extensions (
vendorExtensions
)
- name
- identifier (
Identifier
spdx
case) - url (
Identifier
url
case) - specification extensions (
vendorExtensions
)
- url
- description
- variables
- specification extensions (
vendorExtensions
)
- enum
- default
- description
- specification extensions (
vendorExtensions
)
- schemas
- responses
- parameters
- examples
- requestBodies
- headers
- securitySchemes
- links
- callbacks
- pathItems
- specification extensions (
vendorExtensions
)
- dictionary
[ ] specification extensions(not a planned addition)
- $ref
- summary
- description
- get
- put
- post
- delete
- options
- head
- patch
- trace
- servers
- parameters
- specification extensions (
vendorExtensions
)
- tags
- summary
- description
- externalDocs
- operationId
- parameters
- requestBody
- responses
- callbacks
- deprecated
- security
- servers
- specification extensions (
vendorExtensions
)
- description
- url
- specification extensions (
vendorExtensions
)
- name
- in (
context
) - description
- required (part of
context
) - deprecated
- allowEmptyValue (part of
context
) - schema (
schemaOrContent
)- style
- explode
- allowReserved
- example
- examples
- content (
schemaOrContent
) - specification extensions (
vendorExtensions
)
- description
- content
- required
- specification extensions (
vendorExtensions
)
- schema
- example
- examples
- encoding
- specification extensions (
vendorExtensions
)
- contentType
- headers
- style
- explode
- allowReserved
- specification extensions
- default (
Response.StatusCode.Code
.default
case) - dictionary
[ ] specification extensions(not a planned addition)
- description
- headers
- content
- links
- specification extensions (
vendorExtensions
)
- {expression}
- specification extensions
- summary
- description
- value
- externalValue (part of
value
) - specification extensions (
vendorExtensions
)
- operationRef (
operation
URL value) - operationId (
operation
String value) - parameters
- requestBody
- description
- server
- specification extensions (
vendorExtensions
)
- description
- required
- deprecated
- schema (
schemaOrContent
)- style
- explode
- allowReserved
- example
- examples
- content (
schemaOrContent
) - specification extensions (
vendorExtensions
)
- name
- description
- externalDocs
- specification extensions (
vendorExtensions
)
- summary
- description
- $ref
- local (same file) reference (
internal
case)- encode
- decode
- dereference
- remote (different file) reference (
external
case)- encode
- decode
- dereference
- local (same file) reference (
- Mostly complete support for JSON Schema inherited keywords (select ones enumerated below)
- discriminator
- readOnly (
permissions
.readOnly
case) - writeOnly (
permissions
.writeOnly
case) - xml
- externalDocs
- example
- deprecated
- specification extensions (
vendorExtensions
)
- propertyName
- mapping
- specification extensions
- name
- namespace
- prefix
- attribute
- wrapped
- specification extensions
- type
- description
- name (
SecurityType
.apiKey
case) - in (
location
inSecurityType
.apiKey
case) - scheme (
SecurityType
.http
case) - bearerFormat (
SecurityType
.http
case) - flows (
SecurityType
.oauth2
case) - openIdConnectUrl (
SecurityType
.openIdConnect
case) - specification extensions (
vendorExtensions
)
- implicit
- password
- clientCredentials
- authorizationCode
- specification extensions
OpenAPI.OauthFlows.Implicit
OpenAPI.OauthFlows.Password
OpenAPI.OauthFlows.ClientCredentials
OpenAPI.OauthFlows.AuthorizationCode
- authorizationUrl
- tokenUrl
- refreshUrl
- scopes
- specification extensions
- {name} (using
JSONReferences
instead of a stringy API)