Theia API Documentation v1.76.0
    Preparing search index...

    Interface OpenApiDocument

    The OpenAPI document describing the external API, see OpenApiDocumentBuilder.

    interface OpenApiDocument {
        components?: {
            securitySchemes: Record<string, { scheme: string; type: string }>;
        };
        info: { description?: string; title: string; version: string };
        openapi: string;
        paths: Record<string, Record<string, OpenApiOperation>>;
        tags?: { description?: string; name: string }[];
    }
    Index

    Properties

    components? info openapi paths tags?

    Properties

    components?: {
        securitySchemes: Record<string, { scheme: string; type: string }>;
    }
    info: { description?: string; title: string; version: string }
    openapi: string
    paths: Record<string, Record<string, OpenApiOperation>>
    tags?: { description?: string; name: string }[]

    Settings

    Member Visibility

    On This Page

    Properties