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

    Documentation of a typed route, published in the OpenAPI document of the external API.

    All documentation is optional: undocumented routes are served all the same and appear in the OpenAPI document with their method, path, and body schema only.

    interface RestRouteDocumentation {
        description?: string;
        operationId?: string;
        params?: Record<string, RestParamDocumentation>;
        responses?: Record<number, RestResponseDocumentation>;
        summary?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    description?: string

    Longer description of the route; CommonMark.

    operationId?: string

    Stable operation id, unique across the external API, e.g. createChatSession.

    params?: Record<string, RestParamDocumentation>

    Documentation of the route's path parameters, e.g. of id for a route registered on /:id.

    responses?: Record<number, RestResponseDocumentation>

    Documented responses of the route by status code. Declarative documentation only, not enforced.

    summary?: string

    Short summary of what the route does.