Setu-TS
    Preparing search index...

    Interface OpenApiOperation

    OpenAPI operation definition.

    0.1.0

    interface OpenApiOperation {
        description?: string;
        operationId: string;
        parameters?: readonly OpenApiParameter[];
        requestBody?: OpenApiRequestBody;
        responses: Record<string, OpenApiResponse>;
        security?: readonly Readonly<Record<string, readonly string[]>>[];
        summary?: string;
        tags?: readonly string[];
        "x-setu-unrepresentable"?: readonly { at: string; reason: string }[];
    }
    Index
    description? operationId parameters? requestBody? responses security? summary? tags? x-setu-unrepresentable?
    description?: string

    Longer operation description, when declared on the route.

    0.10.0

    operationId: string

    Unique operation identifier.

    parameters?: readonly OpenApiParameter[]

    Path/query parameters.

    requestBody?: OpenApiRequestBody

    Request body.

    responses: Record<string, OpenApiResponse>

    Response codes.

    security?: readonly Readonly<Record<string, readonly string[]>>[]

    Security requirements for this operation — declared on the route's schema.security, or derived from its branded guards when OpenApiGeneratorOptions.deriveSecurity is configured (declared wins). Absent when neither applies, which leaves the operation inheriting the document-level requirement; an empty array marks it public, overriding that default.

    summary?: string

    Operation summary.

    tags?: readonly string[]

    Operation tags.

    "x-setu-unrepresentable"?: readonly { at: string; reason: string }[]

    Machine-readable vendor extension naming the schema nodes on THIS operation the transformer could not represent (a zod z.date() field, for example). Each entry names the operation (at) and why (reason). The node itself still degrades to an empty schema — never a throw — so a single unrepresentable field cannot take down /openapi.json. Absent when empty.

    0.1.0-alpha.10

    Settings
    Member Visibility

    On This Page
    Properties