Class OpenApiDocumentBuilderImpl

Default implementation of the OpenApiDocumentBuilder.

Implements

OpenApiDocumentBuilder

Index

Constructors

constructor

new OpenApiDocumentBuilderImpl(): OpenApiDocumentBuilderImpl
Returns OpenApiDocumentBuilderImpl

Properties

`Protected` `Readonly`applicationPackage

applicationPackage: ApplicationPackage

`Protected`sources

sources: readonly OpenApiDocumentSource[] = []

`Protected`tokenConfigured

tokenConfigured: boolean = false

Accessors

`Protected`applicationName

get applicationName(): string
The configured application name, defaulting to 'Eclipse Theia', see FrontendApplicationConfig.

Returns string
- Defined in external-api/src/node/openapi-document-builder.ts:145

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
- includeProtected: boolean = true
Returns OpenApiDocument
Implementation of OpenApiDocumentBuilder.build
- Defined in external-api/src/node/openapi-document-builder.ts:111

`Protected`createEventStreamOperation

createEventStreamOperation(
source: OpenApiDocumentSource,
stream: RestEventStreamRegistration,
): OpenApiOperation
Parameters
- source: OpenApiDocumentSource
- stream: RestEventStreamRegistration
Returns OpenApiOperation
- Defined in external-api/src/node/openapi-document-builder.ts:169

`Protected`createOperation

createOperation(
    source: OpenApiDocumentSource,
    routePath: string,
    documentation?: Pick<
        RestRouteDocumentation,
        "operationId"
        | "summary"
        | "description"
        | "params",
    >,
): OpenApiOperation
Parameters
- source: OpenApiDocumentSource
- routePath: string
- Optionaldocumentation: Pick<
      RestRouteDocumentation,
      "operationId"
      | "summary"
      | "description"
      | "params",
  >
Returns OpenApiOperation
- Defined in external-api/src/node/openapi-document-builder.ts:180

`Protected`createRouteOperation

createRouteOperation(
source: OpenApiDocumentSource,
route: RestRouteRegistration,
): OpenApiOperation
Parameters
- source: OpenApiDocumentSource
- route: RestRouteRegistration
Returns OpenApiOperation
- Defined in external-api/src/node/openapi-document-builder.ts:160

`Protected`info

info(): { description?: string; title: string; version: string }
Returns { description?: string; title: string; version: string }
- Defined in external-api/src/node/openapi-document-builder.ts:137

`Protected`operations

operations(
    document: OpenApiDocument,
    source: OpenApiDocumentSource,
    routePath: string,
): Record<string, OpenApiOperation>
Returns the operations object of the route's full path, creating it if necessary.
Parameters
- document: OpenApiDocument
- source: OpenApiDocumentSource
- routePath: string
Returns Record<string, OpenApiOperation>
- Defined in external-api/src/node/openapi-document-builder.ts:150

`Protected`pathParameters

pathParameters(
expressPath: string,
documentation?: Record<string, RestParamDocumentation>,
): OpenApiParameter[]
Declares all path parameters of the express path, merging in their documentation where given.
Parameters
- expressPath: string
- Optionaldocumentation: Record<string, RestParamDocumentation>
Returns OpenApiParameter[]
- Defined in external-api/src/node/openapi-document-builder.ts:207

`Protected`toApiPath

toApiPath(contributionPath: string, routePath: string): string
Converts the contribution-relative express path to the full OpenAPI path, e.g. /:id to /api/ai/sessions/{id}.
Parameters
- contributionPath: string
- routePath: string
Returns string
- Defined in external-api/src/node/openapi-document-builder.ts:155

`Protected`toResponses

toResponses(
documentation?: RestRouteDocumentation,
): Record<string, OpenApiResponse>
Parameters
- Optionaldocumentation: RestRouteDocumentation
Returns Record<string, OpenApiResponse>
- Defined in external-api/src/node/openapi-document-builder.ts:220

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
Implementation of OpenApiDocumentBuilder.update
- Defined in external-api/src/node/openapi-document-builder.ts:106

Class OpenApiDocumentBuilderImpl

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns OpenApiDocumentBuilderImpl

Properties

Protected ReadonlyapplicationPackage

Protectedsources

ProtectedtokenConfigured

Accessors

ProtectedapplicationName

Returns string

Methods

build

Parameters

Returns OpenApiDocument

ProtectedcreateEventStreamOperation

Parameters

Returns OpenApiOperation

ProtectedcreateOperation

Parameters

Returns OpenApiOperation

ProtectedcreateRouteOperation

Parameters

Returns OpenApiOperation

Protectedinfo

Returns { description?: string; title: string; version: string }

Protectedoperations

Parameters

Returns Record<string, OpenApiOperation>

ProtectedpathParameters

Parameters

Returns OpenApiParameter[]

ProtectedtoApiPath

Parameters

Returns string

ProtectedtoResponses

Parameters

Returns Record<string, OpenApiResponse>

update

Parameters

Returns void

Settings

On This Page

`Protected` `Readonly`applicationPackage

`Protected`sources

`Protected`tokenConfigured

`Protected`applicationName

`Protected`createEventStreamOperation

`Protected`createOperation

`Protected`createRouteOperation

`Protected`info

`Protected`operations

`Protected`pathParameters

`Protected`toApiPath

`Protected`toResponses