Beignet API reference
    Preparing search index...

    Type Alias OpenAPIOperationMeta

    OpenAPI operation-level metadata for HTTP contracts.

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

    Properties

    deprecated? description? externalDocs? operationId? security? summary? tags?

    Properties

    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.

    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