| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003 |
- id: https://spec.openapis.org/oas/3.0/schema/2019-04-02
- $schema: http://json-schema.org/draft-04/schema#
- description: Validation schema for OpenAPI Specification 3.0.X.
- type: object
- required:
- - openapi
- - info
- - paths
- properties:
- openapi:
- type: string
- pattern: ^3\.0\.\d(-.+)?$
- info:
- $ref: '#/definitions/Info'
- externalDocs:
- $ref: '#/definitions/ExternalDocumentation'
- servers:
- type: array
- items:
- $ref: '#/definitions/Server'
- security:
- type: array
- items:
- $ref: '#/definitions/SecurityRequirement'
- tags:
- type: array
- items:
- $ref: '#/definitions/Tag'
- uniqueItems: true
- paths:
- $ref: '#/definitions/Paths'
- components:
- $ref: '#/definitions/Components'
- patternProperties:
- '^x-': {}
- additionalProperties: false
- definitions:
- Reference:
- type: object
- required:
- - $ref
- patternProperties:
- '^\$ref$':
- type: string
- format: uri-reference
- Info:
- type: object
- required:
- - title
- - version
- properties:
- title:
- type: string
- description:
- type: string
- termsOfService:
- type: string
- format: uri-reference
- contact:
- $ref: '#/definitions/Contact'
- license:
- $ref: '#/definitions/License'
- version:
- type: string
- patternProperties:
- '^x-': {}
- additionalProperties: false
- Contact:
- type: object
- properties:
- name:
- type: string
- url:
- type: string
- format: uri-reference
- email:
- type: string
- format: email
- patternProperties:
- '^x-': {}
- additionalProperties: false
- License:
- type: object
- required:
- - name
- properties:
- name:
- type: string
- url:
- type: string
- format: uri-reference
- patternProperties:
- '^x-': {}
- additionalProperties: false
- Server:
- type: object
- required:
- - url
- properties:
- url:
- type: string
- description:
- type: string
- variables:
- type: object
- additionalProperties:
- $ref: '#/definitions/ServerVariable'
- patternProperties:
- '^x-': {}
- additionalProperties: false
- ServerVariable:
- type: object
- required:
- - default
- properties:
- enum:
- type: array
- items:
- type: string
- default:
- type: string
- description:
- type: string
- patternProperties:
- '^x-': {}
- additionalProperties: false
- Components:
- type: object
- properties:
- schemas:
- type: object
- patternProperties:
- '^[a-zA-Z0-9\.\-_]+$':
- oneOf:
- - $ref: '#/definitions/Schema'
- - $ref: '#/definitions/Reference'
- responses:
- type: object
- patternProperties:
- '^[a-zA-Z0-9\.\-_]+$':
- oneOf:
- - $ref: '#/definitions/Reference'
- - $ref: '#/definitions/Response'
- parameters:
- type: object
- patternProperties:
- '^[a-zA-Z0-9\.\-_]+$':
- oneOf:
- - $ref: '#/definitions/Reference'
- - $ref: '#/definitions/Parameter'
- examples:
- type: object
- patternProperties:
- '^[a-zA-Z0-9\.\-_]+$':
- oneOf:
- - $ref: '#/definitions/Reference'
- - $ref: '#/definitions/Example'
- requestBodies:
- type: object
- patternProperties:
- '^[a-zA-Z0-9\.\-_]+$':
- oneOf:
- - $ref: '#/definitions/Reference'
- - $ref: '#/definitions/RequestBody'
- headers:
- type: object
- patternProperties:
- '^[a-zA-Z0-9\.\-_]+$':
- oneOf:
- - $ref: '#/definitions/Reference'
- - $ref: '#/definitions/Header'
- securitySchemes:
- type: object
- patternProperties:
- '^[a-zA-Z0-9\.\-_]+$':
- oneOf:
- - $ref: '#/definitions/Reference'
- - $ref: '#/definitions/SecurityScheme'
- links:
- type: object
- patternProperties:
- '^[a-zA-Z0-9\.\-_]+$':
- oneOf:
- - $ref: '#/definitions/Reference'
- - $ref: '#/definitions/Link'
- callbacks:
- type: object
- patternProperties:
- '^[a-zA-Z0-9\.\-_]+$':
- oneOf:
- - $ref: '#/definitions/Reference'
- - $ref: '#/definitions/Callback'
- patternProperties:
- '^x-': {}
- additionalProperties: false
- Schema:
- type: object
- properties:
- title:
- type: string
- multipleOf:
- type: number
- minimum: 0
- exclusiveMinimum: true
- maximum:
- type: number
- exclusiveMaximum:
- type: boolean
- default: false
- minimum:
- type: number
- exclusiveMinimum:
- type: boolean
- default: false
- maxLength:
- type: integer
- minimum: 0
- minLength:
- type: integer
- minimum: 0
- default: 0
- pattern:
- type: string
- format: regex
- maxItems:
- type: integer
- minimum: 0
- minItems:
- type: integer
- minimum: 0
- default: 0
- uniqueItems:
- type: boolean
- default: false
- maxProperties:
- type: integer
- minimum: 0
- minProperties:
- type: integer
- minimum: 0
- default: 0
- required:
- type: array
- items:
- type: string
- minItems: 1
- uniqueItems: true
- enum:
- type: array
- items: {}
- minItems: 1
- uniqueItems: false
- type:
- type: string
- enum:
- - array
- - boolean
- - integer
- - number
- - object
- - string
- not:
- oneOf:
- - $ref: '#/definitions/Schema'
- - $ref: '#/definitions/Reference'
- allOf:
- type: array
- items:
- oneOf:
- - $ref: '#/definitions/Schema'
- - $ref: '#/definitions/Reference'
- oneOf:
- type: array
- items:
- oneOf:
- - $ref: '#/definitions/Schema'
- - $ref: '#/definitions/Reference'
- anyOf:
- type: array
- items:
- oneOf:
- - $ref: '#/definitions/Schema'
- - $ref: '#/definitions/Reference'
- items:
- oneOf:
- - $ref: '#/definitions/Schema'
- - $ref: '#/definitions/Reference'
- properties:
- type: object
- additionalProperties:
- oneOf:
- - $ref: '#/definitions/Schema'
- - $ref: '#/definitions/Reference'
- additionalProperties:
- oneOf:
- - $ref: '#/definitions/Schema'
- - $ref: '#/definitions/Reference'
- - type: boolean
- default: true
- description:
- type: string
- format:
- type: string
- default: {}
- nullable:
- type: boolean
- default: false
- discriminator:
- $ref: '#/definitions/Discriminator'
- readOnly:
- type: boolean
- default: false
- writeOnly:
- type: boolean
- default: false
- example: {}
- externalDocs:
- $ref: '#/definitions/ExternalDocumentation'
- deprecated:
- type: boolean
- default: false
- xml:
- $ref: '#/definitions/XML'
- patternProperties:
- '^x-': {}
- additionalProperties: false
- Discriminator:
- type: object
- required:
- - propertyName
- properties:
- propertyName:
- type: string
- mapping:
- type: object
- additionalProperties:
- type: string
- XML:
- type: object
- properties:
- name:
- type: string
- namespace:
- type: string
- format: uri
- prefix:
- type: string
- attribute:
- type: boolean
- default: false
- wrapped:
- type: boolean
- default: false
- patternProperties:
- '^x-': {}
- additionalProperties: false
- Response:
- type: object
- required:
- - description
- properties:
- description:
- type: string
- headers:
- type: object
- additionalProperties:
- oneOf:
- - $ref: '#/definitions/Header'
- - $ref: '#/definitions/Reference'
- content:
- type: object
- additionalProperties:
- $ref: '#/definitions/MediaType'
- links:
- type: object
- additionalProperties:
- oneOf:
- - $ref: '#/definitions/Link'
- - $ref: '#/definitions/Reference'
- patternProperties:
- '^x-': {}
- additionalProperties: false
- MediaType:
- type: object
- properties:
- schema:
- oneOf:
- - $ref: '#/definitions/Schema'
- - $ref: '#/definitions/Reference'
- example: {}
- examples:
- type: object
- additionalProperties:
- oneOf:
- - $ref: '#/definitions/Example'
- - $ref: '#/definitions/Reference'
- encoding:
- type: object
- additionalProperties:
- $ref: '#/definitions/Encoding'
- patternProperties:
- '^x-': {}
- additionalProperties: false
- allOf:
- - $ref: '#/definitions/ExampleXORExamples'
- Example:
- type: object
- properties:
- summary:
- type: string
- description:
- type: string
- value: {}
- externalValue:
- type: string
- format: uri-reference
- patternProperties:
- '^x-': {}
- additionalProperties: false
- Header:
- type: object
- properties:
- description:
- type: string
- required:
- type: boolean
- default: false
- deprecated:
- type: boolean
- default: false
- allowEmptyValue:
- type: boolean
- default: false
- style:
- type: string
- enum:
- - simple
- default: simple
- explode:
- type: boolean
- allowReserved:
- type: boolean
- default: false
- schema:
- oneOf:
- - $ref: '#/definitions/Schema'
- - $ref: '#/definitions/Reference'
- content:
- type: object
- additionalProperties:
- $ref: '#/definitions/MediaType'
- minProperties: 1
- maxProperties: 1
- example: {}
- examples:
- type: object
- additionalProperties:
- oneOf:
- - $ref: '#/definitions/Example'
- - $ref: '#/definitions/Reference'
- patternProperties:
- '^x-': {}
- additionalProperties: false
- allOf:
- - $ref: '#/definitions/ExampleXORExamples'
- - $ref: '#/definitions/SchemaXORContent'
- Paths:
- type: object
- patternProperties:
- '^\/':
- $ref: '#/definitions/PathItem'
- '^x-': {}
- additionalProperties: false
- PathItem:
- type: object
- properties:
- $ref:
- type: string
- summary:
- type: string
- description:
- type: string
- servers:
- type: array
- items:
- $ref: '#/definitions/Server'
- parameters:
- type: array
- items:
- oneOf:
- - $ref: '#/definitions/Parameter'
- - $ref: '#/definitions/Reference'
- uniqueItems: true
- patternProperties:
- '^(get|put|post|delete|options|head|patch|trace)$':
- $ref: '#/definitions/Operation'
- '^x-': {}
- additionalProperties: false
- Operation:
- type: object
- required:
- - responses
- properties:
- tags:
- type: array
- items:
- type: string
- summary:
- type: string
- description:
- type: string
- externalDocs:
- $ref: '#/definitions/ExternalDocumentation'
- operationId:
- type: string
- parameters:
- type: array
- items:
- oneOf:
- - $ref: '#/definitions/Parameter'
- - $ref: '#/definitions/Reference'
- uniqueItems: true
- requestBody:
- oneOf:
- - $ref: '#/definitions/RequestBody'
- - $ref: '#/definitions/Reference'
- responses:
- $ref: '#/definitions/Responses'
- callbacks:
- type: object
- additionalProperties:
- oneOf:
- - $ref: '#/definitions/Callback'
- - $ref: '#/definitions/Reference'
- deprecated:
- type: boolean
- default: false
- security:
- type: array
- items:
- $ref: '#/definitions/SecurityRequirement'
- servers:
- type: array
- items:
- $ref: '#/definitions/Server'
- patternProperties:
- '^x-': {}
- additionalProperties: false
- Responses:
- type: object
- properties:
- default:
- oneOf:
- - $ref: '#/definitions/Response'
- - $ref: '#/definitions/Reference'
- patternProperties:
- '^[1-5](?:\d{2}|XX)$':
- oneOf:
- - $ref: '#/definitions/Response'
- - $ref: '#/definitions/Reference'
- '^x-': {}
- minProperties: 1
- additionalProperties: false
- SecurityRequirement:
- type: object
- additionalProperties:
- type: array
- items:
- type: string
- Tag:
- type: object
- required:
- - name
- properties:
- name:
- type: string
- description:
- type: string
- externalDocs:
- $ref: '#/definitions/ExternalDocumentation'
- patternProperties:
- '^x-': {}
- additionalProperties: false
- ExternalDocumentation:
- type: object
- required:
- - url
- properties:
- description:
- type: string
- url:
- type: string
- format: uri-reference
- patternProperties:
- '^x-': {}
- additionalProperties: false
- ExampleXORExamples:
- description: Example and examples are mutually exclusive
- not:
- required: [example, examples]
- SchemaXORContent:
- description: Schema and content are mutually exclusive, at least one is required
- not:
- required: [schema, content]
- oneOf:
- - required: [schema]
- - required: [content]
- description: Some properties are not allowed if content is present
- allOf:
- - not:
- required: [style]
- - not:
- required: [explode]
- - not:
- required: [allowReserved]
- - not:
- required: [example]
- - not:
- required: [examples]
- Parameter:
- type: object
- properties:
- name:
- type: string
- in:
- type: string
- description:
- type: string
- required:
- type: boolean
- default: false
- deprecated:
- type: boolean
- default: false
- allowEmptyValue:
- type: boolean
- default: false
- style:
- type: string
- explode:
- type: boolean
- allowReserved:
- type: boolean
- default: false
- schema:
- oneOf:
- - $ref: '#/definitions/Schema'
- - $ref: '#/definitions/Reference'
- content:
- type: object
- additionalProperties:
- $ref: '#/definitions/MediaType'
- minProperties: 1
- maxProperties: 1
- example: {}
- examples:
- type: object
- additionalProperties:
- oneOf:
- - $ref: '#/definitions/Example'
- - $ref: '#/definitions/Reference'
- patternProperties:
- '^x-': {}
- additionalProperties: false
- required:
- - name
- - in
- allOf:
- - $ref: '#/definitions/ExampleXORExamples'
- - $ref: '#/definitions/SchemaXORContent'
- - $ref: '#/definitions/ParameterLocation'
- ParameterLocation:
- description: Parameter location
- oneOf:
- - description: Parameter in path
- required:
- - required
- properties:
- in:
- enum: [path]
- style:
- enum: [matrix, label, simple]
- default: simple
- required:
- enum: [true]
- - description: Parameter in query
- properties:
- in:
- enum: [query]
- style:
- enum: [form, spaceDelimited, pipeDelimited, deepObject]
- default: form
- - description: Parameter in header
- properties:
- in:
- enum: [header]
- style:
- enum: [simple]
- default: simple
- - description: Parameter in cookie
- properties:
- in:
- enum: [cookie]
- style:
- enum: [form]
- default: form
- RequestBody:
- type: object
- required:
- - content
- properties:
- description:
- type: string
- content:
- type: object
- additionalProperties:
- $ref: '#/definitions/MediaType'
- required:
- type: boolean
- default: false
- patternProperties:
- '^x-': {}
- additionalProperties: false
- SecurityScheme:
- oneOf:
- - $ref: '#/definitions/APIKeySecurityScheme'
- - $ref: '#/definitions/HTTPSecurityScheme'
- - $ref: '#/definitions/OAuth2SecurityScheme'
- - $ref: '#/definitions/OpenIdConnectSecurityScheme'
- APIKeySecurityScheme:
- type: object
- required:
- - type
- - name
- - in
- properties:
- type:
- type: string
- enum:
- - apiKey
- name:
- type: string
- in:
- type: string
- enum:
- - header
- - query
- - cookie
- description:
- type: string
- patternProperties:
- '^x-': {}
- additionalProperties: false
- HTTPSecurityScheme:
- type: object
- required:
- - scheme
- - type
- properties:
- scheme:
- type: string
- bearerFormat:
- type: string
- description:
- type: string
- type:
- type: string
- enum:
- - http
- patternProperties:
- '^x-': {}
- additionalProperties: false
- oneOf:
- - description: Bearer
- properties:
- scheme:
- enum: [bearer]
- - description: Non Bearer
- not:
- required: [bearerFormat]
- properties:
- scheme:
- not:
- enum: [bearer]
- OAuth2SecurityScheme:
- type: object
- required:
- - type
- - flows
- properties:
- type:
- type: string
- enum:
- - oauth2
- flows:
- $ref: '#/definitions/OAuthFlows'
- description:
- type: string
- patternProperties:
- '^x-': {}
- additionalProperties: false
- OpenIdConnectSecurityScheme:
- type: object
- required:
- - type
- - openIdConnectUrl
- properties:
- type:
- type: string
- enum:
- - openIdConnect
- openIdConnectUrl:
- type: string
- format: uri-reference
- description:
- type: string
- patternProperties:
- '^x-': {}
- additionalProperties: false
- OAuthFlows:
- type: object
- properties:
- implicit:
- $ref: '#/definitions/ImplicitOAuthFlow'
- password:
- $ref: '#/definitions/PasswordOAuthFlow'
- clientCredentials:
- $ref: '#/definitions/ClientCredentialsFlow'
- authorizationCode:
- $ref: '#/definitions/AuthorizationCodeOAuthFlow'
- patternProperties:
- '^x-': {}
- additionalProperties: false
- ImplicitOAuthFlow:
- type: object
- required:
- - authorizationUrl
- - scopes
- properties:
- authorizationUrl:
- type: string
- format: uri-reference
- refreshUrl:
- type: string
- format: uri-reference
- scopes:
- type: object
- additionalProperties:
- type: string
- patternProperties:
- '^x-': {}
- additionalProperties: false
- PasswordOAuthFlow:
- type: object
- required:
- - tokenUrl
- properties:
- tokenUrl:
- type: string
- format: uri-reference
- refreshUrl:
- type: string
- format: uri-reference
- scopes:
- type: object
- additionalProperties:
- type: string
- patternProperties:
- '^x-': {}
- additionalProperties: false
- ClientCredentialsFlow:
- type: object
- required:
- - tokenUrl
- properties:
- tokenUrl:
- type: string
- format: uri-reference
- refreshUrl:
- type: string
- format: uri-reference
- scopes:
- type: object
- additionalProperties:
- type: string
- patternProperties:
- '^x-': {}
- additionalProperties: false
- AuthorizationCodeOAuthFlow:
- type: object
- required:
- - authorizationUrl
- - tokenUrl
- properties:
- authorizationUrl:
- type: string
- format: uri-reference
- tokenUrl:
- type: string
- format: uri-reference
- refreshUrl:
- type: string
- format: uri-reference
- scopes:
- type: object
- additionalProperties:
- type: string
- patternProperties:
- '^x-': {}
- additionalProperties: false
- Link:
- type: object
- properties:
- operationId:
- type: string
- operationRef:
- type: string
- format: uri-reference
- parameters:
- type: object
- additionalProperties: {}
- requestBody: {}
- description:
- type: string
- server:
- $ref: '#/definitions/Server'
- patternProperties:
- '^x-': {}
- additionalProperties: false
- not:
- description: Operation Id and Operation Ref are mutually exclusive
- required: [operationId, operationRef]
- Callback:
- type: object
- additionalProperties:
- $ref: '#/definitions/PathItem'
- patternProperties:
- '^x-': {}
- Encoding:
- type: object
- properties:
- contentType:
- type: string
- headers:
- type: object
- additionalProperties:
- $ref: '#/definitions/Header'
- style:
- type: string
- enum:
- - form
- - spaceDelimited
- - pipeDelimited
- - deepObject
- explode:
- type: boolean
- allowReserved:
- type: boolean
- default: false
- additionalProperties: false
|