Stone.js API
    Preparing search index...

    Interface OpenApiOperation

    A single operation (one method on one path).

    interface OpenApiOperation {
        description?: string;
        operationId?: string;
        parameters?: Record<string, unknown>[];
        request?: {
            body?: SchemaInput;
            headers?: SchemaInput;
            params?: SchemaInput;
            query?: SchemaInput;
        };
        responses?: Record<string | number, OpenApiResponse>;
        security?: Record<string, string[]>[];
        summary?: string;
        tags?: string[];
    }
    Index
    description? operationId? parameters? request? responses? security? summary? tags?
    description?: string
    operationId?: string
    parameters?: Record<string, unknown>[]

    Parameters stated outright, merged with those derived from the request schemas.

    For anything a schema cannot express: the fragment a resource lets a caller select, for instance, which is a closed set of names rather than a shape.

    request?: {
        body?: SchemaInput;
        headers?: SchemaInput;
        params?: SchemaInput;
        query?: SchemaInput;
    }
    responses?: Record<string | number, OpenApiResponse>
    security?: Record<string, string[]>[]

    Security requirements for this operation, as OpenAPI expects them.

    Derived from a route's auth and authz when the document is built from the router, so a protected endpoint documents itself as protected without anyone restating it.

    summary?: string
    tags?: string[]

    Settings
    Member Visibility

    On This Page
    Properties