Optional ReadonlydocumentationDocumentation of this contribution, grouping its routes under an OpenAPI tag in the OpenAPI document of the external API.
ReadonlypathAbsolute path under which this contribution's routes are mounted, e.g. /api/ai/sessions.
The server imposes no path conventions, but each contribution answers all requests below
its path, so contribution paths must not nest: a contribution whose path nests with the
path of another contribution is skipped with a warning. With samePort delivery the path
also must not nest with one of Theia's own routes on the main server, as it would shadow
them; the server cannot detect that case.
Optional ReadonlyunprotectedServe this contribution without token verification even when a token is configured.
Intended for endpoints with their own authentication or endpoints that are
conventionally public. Defaults to false.
Registers the contribution's routes, see ExternalApiRouter.
Called whenever the routing is (re)built, i.e. when the external API server
configuration changes. The router of the previous build, including everything
registered in its toDispose collection, is disposed beforehand, so build-scoped
state is set up here rather than held across builds.
Contributes HTTP endpoints to the external API server.
Unlike BackendApplicationContributions, which extend Theia's main HTTP server, these endpoints are served on the dedicated, preference-configured external API port and are intended for consumption by external tools.
When an external API token is configured, contributions are protected by bearer token verification unless they opt out via unprotected.