Interface IDocument

OpenAPI document structure.

interface IDocument {
    components?: OpenApiV3_1.IComponents;
    info?: OpenApiV3_1.IDocument.IInfo;
    openapi: `3.1.${number}`;
    paths?: Record<string, OpenApiV3_1.IPath>;
    security?: Record<string, string[]>[];
    servers?: OpenApiV3_1.IServer[];
    tags?: OpenApiV3_1.IDocument.ITag[];
    webhooks?: Record<
        string,
        | OpenApiV3_1.IPath
        | OpenApiV3_1.IJsonSchema.IReference<`#/components/pathItems/${string}`>,
    >;
}

Index

Properties

components? info? openapi paths? security? servers? tags? webhooks?

Properties

`Optional`components

components?: OpenApiV3_1.IComponents

Reusable components.

`Optional`info

info?: OpenApiV3_1.IDocument.IInfo

API metadata.

openapi

openapi: `3.1.${number}`

OpenAPI version.

`Optional`paths

paths?: Record<string, OpenApiV3_1.IPath>

API paths and operations.

`Optional`security

security?: Record<string, string[]>[]

Global security requirements.

`Optional`servers

servers?: OpenApiV3_1.IServer[]

List of servers.

`Optional`tags

tags?: OpenApiV3_1.IDocument.ITag[]

Tag definitions.

`Optional`webhooks

webhooks?: Record<
    string,
    | OpenApiV3_1.IPath
    | OpenApiV3_1.IJsonSchema.IReference<`#/components/pathItems/${string}`>,
>

Webhook definitions.