Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/openapi-json/_shared/latest--2025-09-15.json
Parent schema openapi-json
Type: object

The description of OpenAPI v3.1.x Documents without Schema Object validation

Properties

openapi string required
pattern=^3\.1\.\d+(-.+)?$
info object required
7 nested properties
title string required
version string required
summary string
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
3 nested properties
name string required
identifier string
url string
format=uri-reference
jsonSchemaDialect string
Default: "https://spec.openapis.org/oas/3.1/dialect/2024-11-10"
format=uri-reference
servers server[]
Default:
[
  {
    "url": "/"
  }
]
paths object
webhooks Record<string, object>
components object
10 nested properties
schemas Record<string, any>
responses Record<string, response-or-reference>
parameters Record<string, parameter-or-reference>
examples Record<string, example-or-reference>
requestBodies Record<string, request-body-or-reference>
headers Record<string, header-or-reference>
securitySchemes Record<string, security-scheme-or-reference>
links Record<string, link-or-reference>
callbacks Record<string, callbacks-or-reference>
pathItems Record<string, object>
tags tag[]
externalDocs object
2 nested properties
url string required
format=uri-reference
description string

Any of

1. variant
2. variant
3. variant

Definitions

info
contact
license
server
server-variable
components
paths
path-item
operation
external-documentation
parameter
parameter-or-reference
request-body
request-body-or-reference
content Record<string, object>
media-type object
schema
encoding Record<string, object>
encoding object
contentType string
format=media-range
headers Record<string, header-or-reference>
style enum
Values: "form" "spaceDelimited" "pipeDelimited" "deepObject"
explode boolean
allowReserved boolean
responses
response
response-or-reference
callbacks
callbacks-or-reference
example
example-or-reference
header
header-or-reference
tag
reference object
$ref string
format=uri-reference
summary string
description string
schema object | boolean
security-scheme object
type enum required
Values: "apiKey" "http" "mutualTLS" "oauth2" "openIdConnect"
description string
security-scheme-or-reference
oauth-flows
security-requirement Record<string, string[]>
specification-extensions
examples object
example
examples Record<string, example-or-reference>
map-of-strings Record<string, string>
styles-for-form