Documentation
    Preparing search index...

    Interface IDocument

    Root document structure for emended OpenAPI v3.2.

    Contains all API metadata, paths, operations, and reusable components. The x-samchon-emended-v4 marker indicates this document has been processed by samchon/typia to normalize schema formats.

    interface IDocument {
        components: OpenApi.IComponents;
        info?: OpenApi.IDocument.IInfo;
        openapi: `3.2.${number}`;
        paths?: Record<string, OpenApi.IPath>;
        security?: Record<string, string[]>[];
        servers?: OpenApi.IServer[];
        tags?: OpenApi.IDocument.ITag[];
        webhooks?: Record<string, OpenApi.IPath>;
        "x-typia-emended-v12": true;
    }
    Index

    Properties

    components info? openapi paths? security? servers? tags? webhooks? x-typia-emended-v12

    Properties

    components: OpenApi.IComponents

    Reusable components (schemas, security schemes).

    info?: OpenApi.IDocument.IInfo

    API metadata.

    openapi: `3.2.${number}`

    OpenAPI version.

    paths?: Record<string, OpenApi.IPath>

    Available API paths and operations.

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

    Global security requirements.

    servers?: OpenApi.IServer[]

    List of servers providing the API.

    tags?: OpenApi.IDocument.ITag[]

    Tag definitions for grouping operations.

    webhooks?: Record<string, OpenApi.IPath>

    Webhook definitions.

    "x-typia-emended-v12": true

    Marker for emended document by typia

    Settings

    Member Visibility

    On This Page

    Properties