Interface OpenApiDocumentBuilder

Builds the OpenAPI document describing the external API.

The external API server records the typed routes and event streams of all contributions on each routing build; the document is assembled on demand from those recordings, e.g. by the OpenApiSpecContribution serving it. Routes registered on a contribution's raw express router are not recorded and do not appear in the document.

Rebind the OpenApiDocumentBuilder to customize the document.

interface OpenApiDocumentBuilder {
    build(includeProtected?: boolean): OpenApiDocument;
    update(
        sources: readonly OpenApiDocumentSource[],
        tokenConfigured: boolean,
    ): void;
}

Implemented by

OpenApiDocumentBuilderImpl

Index

Methods

build update

Methods

build

build(includeProtected?: boolean): OpenApiDocument
Builds the OpenAPI document for the routes of the current routing build. With includeProtected set to false, the document covers only the contributions served without token verification, i.e. the view presented to unauthorized requests.
Parameters
- OptionalincludeProtected: boolean
Returns OpenApiDocument
- Defined in external-api/src/node/openapi-document-builder.ts:91

update

update(
sources: readonly OpenApiDocumentSource[],
tokenConfigured: boolean,
): void
Replaces the documented routes; called by the external API server on each routing build.
Parameters
- sources: readonly OpenApiDocumentSource[]
- tokenConfigured: boolean
Returns void
- Defined in external-api/src/node/openapi-document-builder.ts:85

Interface OpenApiDocumentBuilder

Implemented by

Index

Methods

Methods

build

Parameters

Returns OpenApiDocument

update

Parameters

Returns void

Settings

On This Page