Beignet API reference
    Preparing search index...

    Interface OperationObject

    OpenAPI operation object.

    interface OperationObject {
        deprecated?: boolean;
        description?: string;
        externalDocs?: { description?: string; url: string };
        operationId?: string;
        parameters?: ParameterObject[];
        requestBody?: RequestBodyObject;
        responses: Record<string, ResponseObject>;
        security?: Record<string, string[]>[];
        summary?: string;
        tags?: string[];
        "x-beignet-deprecation"?: ContractDeprecationMeta;
    }
    Index
    deprecated? description? externalDocs? operationId? parameters? requestBody? responses security? summary? tags? x-beignet-deprecation?
    deprecated?: boolean

    Whether the operation is deprecated.

    description?: string

    Operation description.

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

    External documentation.

    operationId?: string

    Operation ID.

    parameters?: ParameterObject[]

    Operation parameters.

    requestBody?: RequestBodyObject

    Operation request body.

    responses: Record<string, ResponseObject>

    Operation responses keyed by status code.

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

    Operation-specific security requirements.

    summary?: string

    Operation summary.

    tags?: string[]

    Operation tags.

    "x-beignet-deprecation"?: ContractDeprecationMeta

    Beignet lifecycle details for a deprecated operation.

    Settings
    Member Visibility

    On This Page
    Properties