Documentation
    Preparing search index...

    Interface IOperation

    API operation metadata.

    interface IOperation {
        deprecated?: boolean;
        description?: string;
        operationId?: string;
        parameters?: OpenApi.IOperation.IParameter[];
        requestBody?: OpenApi.IOperation.IRequestBody;
        responses?: Record<string, OpenApi.IOperation.IResponse>;
        security?: Record<string, string[]>[];
        servers?: OpenApi.IServer[];
        summary?: string;
        tags?: string[];
        "x-samchon-accessor"?: string[];
        "x-samchon-controller"?: string;
        "x-samchon-human"?: boolean;
    }
    Index

    Properties

    deprecated? description? operationId? parameters? requestBody? responses? security? servers? summary? tags? x-samchon-accessor? x-samchon-controller? x-samchon-human?

    Properties

    deprecated?: boolean

    Whether deprecated.

    description?: string

    Full description.

    operationId?: string

    Unique operation identifier.

    parameters?: OpenApi.IOperation.IParameter[]

    Operation parameters.

    requestBody?: OpenApi.IOperation.IRequestBody

    Request body.

    responses?: Record<string, OpenApi.IOperation.IResponse>

    Response definitions by status code.

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

    Security requirements.

    servers?: OpenApi.IServer[]

    Operation-level servers.

    summary?: string

    Short summary.

    tags?: string[]

    Operation tags for grouping.

    "x-samchon-accessor"?: string[]

    Custom accessor path for migration.

    "x-samchon-controller"?: string

    Controller name for code generation.

    "x-samchon-human"?: boolean

    Excludes from LLM function calling when true.

    Settings

    Member Visibility

    On This Page

    Properties