Variable buildSpec

Type Declaration

• • (
        routes: any,
        options: any,
    ): {
        components: Record<string, any>;
        info: {
            description: string;
            license: { name: string };
            title: string;
            version: any;
        };
        openapi: string;
        paths: {};
        security: (
            | { bearerAuth?: undefined; oauth2: string[] }
            | { bearerAuth: any[]; oauth2?: undefined }
        )[];
        servers: { description: string; url: any }[];
        tags: { description: any; name: any }[];
    }

  • Returns the whole OpenAPI document for the given route table, one operation per plain route and one per action at its concrete URL.

    With the gate off (authRequired: false) the document carries security: [] and no schemes; a caller that omits the option gets the protected document.

    Parameters

    • routes: any

      admin_api.ts's route table

    • options: any

      baseUrl, version and authRequired (default true)

    Returns {
        components: Record<string, any>;
        info: {
            description: string;
            license: { name: string };
            title: string;
            version: any;
        };
        openapi: string;
        paths: {};
        security: (
            | { bearerAuth?: undefined; oauth2: string[] }
            | { bearerAuth: any[]; oauth2?: undefined }
        )[];
        servers: { description: string; url: any }[];
        tags: { description: any; name: any }[];
    }

    the OpenAPI 3.1.0 document