The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/CreateDocumentationPartRequest",
"title": "CreateDocumentationPartRequest",
"type": "object",
"required": [
"location",
"properties"
],
"properties": {
"location": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentationPartLocation"
},
{
"description": "The location of the targeted API entity of the to-be-created documentation part."
}
]
},
"properties": {
"description": "The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published."
}
},
"description": "Creates a new documentation part of a given API."
}