TypeScript API / contentia/json-api / OpenApiDocument
Interface: OpenApiDocument
Properties
components?
ts
components?: object;parameters?
ts
parameters?: Record<string, OpenApiParameter>;requestBodies?
ts
requestBodies?: Record<string, OpenApiRequestBody>;responses?
ts
responses?: Record<string, OpenApiResponse>;schemas?
ts
schemas?: Record<string, OpenApiSchema>;info
ts
info: object;contact?
ts
contact?: object;contact.email?
ts
email?: string;contact.name?
ts
name?: string;contact.url?
ts
url?: string;description?
ts
description?: string;license?
ts
license?: object;license.identifier?
ts
identifier?: string;license.name
ts
name: string;license.url?
ts
url?: string;summary?
ts
summary?: string;title
ts
title: string;version
ts
version: string;openapi
ts
openapi: string;paths
ts
paths: Record<string, OpenApiPathItem>;servers?
ts
servers?: object[];description?
ts
description?: string;url
ts
url: string;tags?
ts
tags?: object[];description?
ts
description?: string;name
ts
name: string;