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