latest--2024-10-18

shared
Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/openapi-json/_shared/latest--2024-10-18.json
Parent schema openapi-json
Type: object

The description of OpenAPI v3.0.x Documents

Properties

openapi string required
pattern=^3\.0\.\d(-.+)?$
info object required
6 nested properties
title string required
version string required
description string
termsOfService string
format=uri-reference
contact object
3 nested properties
name string
url string
format=uri-reference
email string
format=email
license object
2 nested properties
name string required
url string
format=uri-reference
paths object required
externalDocs object
2 nested properties
url string required
format=uri-reference
description string
servers Server[]
tags Tag[]
uniqueItems=true
components object
9 nested properties
schemas object
responses object
parameters object
examples object
requestBodies object
headers object
securitySchemes object
links object
callbacks object

Definitions

Reference object
Info object
title string required
version string required
description string
termsOfService string
format=uri-reference
contact object
3 nested properties
name string
url string
format=uri-reference
email string
format=email
license object
2 nested properties
name string required
url string
format=uri-reference
Contact object
name string
url string
format=uri-reference
email string
format=email
License object
name string required
url string
format=uri-reference
Server object
url string required
description string
variables Record<string, object>
ServerVariable object
default string required
enum string[]
description string
Components object
schemas object
responses object
parameters object
examples object
requestBodies object
headers object
securitySchemes object
links object
callbacks object
Schema object
title string
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength integer
Default: 0
min=0
pattern string
format=regex
maxItems integer
min=0
minItems integer
Default: 0
min=0
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties integer
Default: 0
min=0
required string[]
minItems=1uniqueItems=true
enum array
minItems=1
type string
Values: "array" "boolean" "integer" "number" "object" "string"
not Schema | Reference
allOf Schema | Reference[]
oneOf Schema | Reference[]
anyOf Schema | Reference[]
items Schema | Reference
properties Record<string, Schema | Reference>
additionalProperties Schema | Reference | boolean
Default: true
description string
format string
default
nullable boolean
Default: false
discriminator object
2 nested properties
propertyName string required
mapping Record<string, string>
readOnly boolean
Default: false
writeOnly boolean
Default: false
example
externalDocs object
2 nested properties
url string required
format=uri-reference
description string
deprecated boolean
Default: false
xml object
5 nested properties
name string
namespace string
format=uri
prefix string
attribute boolean
Default: false
wrapped boolean
Default: false
Discriminator object
propertyName string required
mapping Record<string, string>
XML object
name string
namespace string
format=uri
prefix string
attribute boolean
Default: false
wrapped boolean
Default: false
Response object
description string required
headers Record<string, Header | Reference>
content Record<string, object>
links Record<string, Link | Reference>
MediaType object
schema Schema | Reference
example
examples Record<string, Example | Reference>
encoding Record<string, object>
Example object
summary string
description string
value
externalValue string
format=uri-reference
Header object
description string
required boolean
Default: false
deprecated boolean
Default: false
allowEmptyValue boolean
Default: false
style string
Default: "simple"
Values: "simple"
explode boolean
allowReserved boolean
Default: false
schema Schema | Reference
content Record<string, object>
example
examples Record<string, Example | Reference>
Paths object
PathItem object
$ref string
summary string
description string
get object
12 nested properties
responses object required
1 nested properties
default Response | Reference
tags string[]
summary string
description string
externalDocs object
2 nested properties
url string required
format=uri-reference
description string
operationId string
parameters Parameter | Reference[]
uniqueItems=true
requestBody RequestBody | Reference
callbacks Record<string, Callback | Reference>
deprecated boolean
Default: false
security SecurityRequirement[]
servers Server[]
put object
12 nested properties
responses object required
1 nested properties
default Response | Reference
tags string[]
summary string
description string
externalDocs object
2 nested properties
url string required
format=uri-reference
description string
operationId string
parameters Parameter | Reference[]
uniqueItems=true
requestBody RequestBody | Reference
callbacks Record<string, Callback | Reference>
deprecated boolean
Default: false
security SecurityRequirement[]
servers Server[]
post object
12 nested properties
responses object required
1 nested properties
default Response | Reference
tags string[]
summary string
description string
externalDocs object
2 nested properties
url string required
format=uri-reference
description string
operationId string
parameters Parameter | Reference[]
uniqueItems=true
requestBody RequestBody | Reference
callbacks Record<string, Callback | Reference>
deprecated boolean
Default: false
security SecurityRequirement[]
servers Server[]
delete object
12 nested properties
responses object required
1 nested properties
default Response | Reference
tags string[]
summary string
description string
externalDocs object
2 nested properties
url string required
format=uri-reference
description string
operationId string
parameters Parameter | Reference[]
uniqueItems=true
requestBody RequestBody | Reference
callbacks Record<string, Callback | Reference>
deprecated boolean
Default: false
security SecurityRequirement[]
servers Server[]
options object
12 nested properties
responses object required
1 nested properties
default Response | Reference
tags string[]
summary string
description string
externalDocs object
2 nested properties
url string required
format=uri-reference
description string
operationId string
parameters Parameter | Reference[]
uniqueItems=true
requestBody RequestBody | Reference
callbacks Record<string, Callback | Reference>
deprecated boolean
Default: false
security SecurityRequirement[]
servers Server[]
head object
12 nested properties
responses object required
1 nested properties
default Response | Reference
tags string[]
summary string
description string
externalDocs object
2 nested properties
url string required
format=uri-reference
description string
operationId string
parameters Parameter | Reference[]
uniqueItems=true
requestBody RequestBody | Reference
callbacks Record<string, Callback | Reference>
deprecated boolean
Default: false
security SecurityRequirement[]
servers Server[]
patch object
12 nested properties
responses object required
1 nested properties
default Response | Reference
tags string[]
summary string
description string
externalDocs object
2 nested properties
url string required
format=uri-reference
description string
operationId string
parameters Parameter | Reference[]
uniqueItems=true
requestBody RequestBody | Reference
callbacks Record<string, Callback | Reference>
deprecated boolean
Default: false
security SecurityRequirement[]
servers Server[]
trace object
12 nested properties
responses object required
1 nested properties
default Response | Reference
tags string[]
summary string
description string
externalDocs object
2 nested properties
url string required
format=uri-reference
description string
operationId string
parameters Parameter | Reference[]
uniqueItems=true
requestBody RequestBody | Reference
callbacks Record<string, Callback | Reference>
deprecated boolean
Default: false
security SecurityRequirement[]
servers Server[]
servers Server[]
parameters Parameter | Reference[]
uniqueItems=true
Operation object
responses object required
1 nested properties
default Response | Reference
tags string[]
summary string
description string
externalDocs object
2 nested properties
url string required
format=uri-reference
description string
operationId string
parameters Parameter | Reference[]
uniqueItems=true
requestBody RequestBody | Reference
callbacks Record<string, Callback | Reference>
deprecated boolean
Default: false
security SecurityRequirement[]
servers Server[]
Responses object
default Response | Reference
SecurityRequirement Record<string, string[]>
Tag object
name string required
description string
externalDocs object
2 nested properties
url string required
format=uri-reference
description string
ExternalDocumentation object
url string required
format=uri-reference
description string
ExampleXORExamples

Example and examples are mutually exclusive

SchemaXORContent

Schema and content are mutually exclusive, at least one is required

Parameter object
name string required
in string required
description string
required boolean
Default: false
deprecated boolean
Default: false
allowEmptyValue boolean
Default: false
style string
explode boolean
allowReserved boolean
Default: false
schema Schema | Reference
content Record<string, object>
example
examples Record<string, Example | Reference>
PathParameter object

Parameter in path

required enum required
Values: true
in enum
Values: "path"
style enum
Default: "simple"
Values: "matrix" "label" "simple"
QueryParameter

Parameter in query

in enum
Values: "query"
style enum
Default: "form"
Values: "form" "spaceDelimited" "pipeDelimited" "deepObject"
HeaderParameter

Parameter in header

in enum
Values: "header"
style enum
Default: "simple"
Values: "simple"
CookieParameter

Parameter in cookie

in enum
Values: "cookie"
style enum
Default: "form"
Values: "form"
RequestBody object
content Record<string, object> required
description string
required boolean
Default: false
SecurityScheme APIKeySecurityScheme | HTTPSecurityScheme | OAuth2SecurityScheme | OpenIdConnectSecurityScheme
APIKeySecurityScheme object
type string required
Values: "apiKey"
name string required
in string required
Values: "header" "query" "cookie"
description string
HTTPSecurityScheme object
scheme string required
type string required
Values: "http"
bearerFormat string
description string
OAuth2SecurityScheme object
type string required
Values: "oauth2"
flows object required
4 nested properties
implicit object
3 nested properties
authorizationUrl string required
format=uri-reference
scopes Record<string, string> required
refreshUrl string
format=uri-reference
password object
3 nested properties
tokenUrl string required
format=uri-reference
scopes Record<string, string> required
refreshUrl string
format=uri-reference
clientCredentials object
3 nested properties
tokenUrl string required
format=uri-reference
scopes Record<string, string> required
refreshUrl string
format=uri-reference
authorizationCode object
4 nested properties
authorizationUrl string required
format=uri-reference
tokenUrl string required
format=uri-reference
scopes Record<string, string> required
refreshUrl string
format=uri-reference
description string
OpenIdConnectSecurityScheme object
type string required
Values: "openIdConnect"
openIdConnectUrl string required
format=uri-reference
description string
OAuthFlows object
implicit object
3 nested properties
authorizationUrl string required
format=uri-reference
scopes Record<string, string> required
refreshUrl string
format=uri-reference
password object
3 nested properties
tokenUrl string required
format=uri-reference
scopes Record<string, string> required
refreshUrl string
format=uri-reference
clientCredentials object
3 nested properties
tokenUrl string required
format=uri-reference
scopes Record<string, string> required
refreshUrl string
format=uri-reference
authorizationCode object
4 nested properties
authorizationUrl string required
format=uri-reference
tokenUrl string required
format=uri-reference
scopes Record<string, string> required
refreshUrl string
format=uri-reference
ImplicitOAuthFlow object
authorizationUrl string required
format=uri-reference
scopes Record<string, string> required
refreshUrl string
format=uri-reference
PasswordOAuthFlow object
tokenUrl string required
format=uri-reference
scopes Record<string, string> required
refreshUrl string
format=uri-reference
ClientCredentialsFlow object
tokenUrl string required
format=uri-reference
scopes Record<string, string> required
refreshUrl string
format=uri-reference
AuthorizationCodeOAuthFlow object
authorizationUrl string required
format=uri-reference
tokenUrl string required
format=uri-reference
scopes Record<string, string> required
refreshUrl string
format=uri-reference
Callback Record<string, object>
Encoding object
contentType string
headers Record<string, Header | Reference>
style string
Values: "form" "spaceDelimited" "pipeDelimited" "deepObject"
explode boolean
allowReserved boolean
Default: false