Beignet API reference
    Preparing search index...

    Type Alias OpenAPIOperationMeta

    OpenAPI operation metadata type.

    type OpenAPIOperationMeta = {
        deprecated?: boolean;
        description?: string;
        externalDocs?: { description?: string; url: string };
        operationId?: string;
        parameters?: OpenAPIParameterMeta[];
        requestBody?: OpenAPIRequestBodyMeta;
        responses?: Record<string, OpenAPIResponseMeta>;
        security?: Record<string, string[]>[];
        summary?: string;
        tags?: string[];
    }
    Index
    deprecated? description? externalDocs? operationId? parameters? requestBody? responses? security? summary? tags?
    deprecated?: boolean

    Whether the operation is deprecated.

    description?: string

    Detailed operation description.

    externalDocs?: { description?: string; url: string }

    External documentation reference.

    operationId?: string

    Operation ID override. Defaults to contract.name.

    parameters?: OpenAPIParameterMeta[]

    Additional or replacement operation parameters.

    requestBody?: OpenAPIRequestBodyMeta

    Replacement request body for non-JSON media such as multipart uploads.

    responses?: Record<string, OpenAPIResponseMeta>

    Additional or replacement responses, useful for files and streams.

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

    Per-operation security requirements.

    summary?: string

    Brief operation summary.

    tags?: string[]

    Tags used to group operations.

    Settings
    Member Visibility

    On This Page
    Properties