OpenApiDocument
{
"type": "object",
"properties": {
"openapi": {
"type": "string",
"description": "OpenAPI version, 3.1.0."
},
"info": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "API title."
},
"version": {
"type": "string",
"description": "API version."
},
"contact": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Contact name."
},
"url": {
"type": "string",
"description": "Contact URL."
}
},
"required": [
"name",
"url"
],
"description": "Who publishes the API."
}
},
"required": [
"title",
"version",
"contact"
],
"description": "API metadata."
},
"servers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Base URL."
}
},
"required": [
"url"
]
},
"description": "Base URLs the API is served from."
},
"paths": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {}
},
"description": "Every operation, keyed by path then HTTP method. An open map: each value is an OpenAPI path item object."
},
"components": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {}
},
"description": "Shared schemas and security schemes, keyed by component kind then name. An open map of OpenAPI component objects."
}
},
"required": [
"openapi",
"info",
"servers",
"paths",
"components"
],
"description": "This OpenAPI 3.1 document, the one you are reading."
}