oag-mcp
    Preparing search index...

    Interface MethodRecord

    An SDK method bound to an OpenAPI operation. This is what search returns and what execute exposes as sdk.<className>.<methodName>.

    interface MethodRecord {
        apiParameters: ParameterInfo[];
        auth: AuthSummary;
        className: string;
        deprecated: boolean;
        description?: string;
        example: string;
        httpMethod: string;
        id: string;
        inputType?: TypeDeclaration;
        methodName: string;
        operationId?: string;
        parameters: { name: string; optional: boolean; type: string }[];
        path: string;
        referencedTypes: TypeDeclaration[];
        requestBody?: {
            contentTypes: string[];
            description?: string;
            example?: unknown;
            required: boolean;
            schemaType: string;
        };
        requiredArguments: string[];
        responses: Record<string, string>;
        returnType: string;
        sdkPath: string;
        security: SecurityRequirement[];
        signature: string;
        summary?: string;
        tags: string[];
    }
    Index
    apiParameters auth className deprecated description? example httpMethod id inputType? methodName operationId? parameters path referencedTypes requestBody? requiredArguments responses returnType sdkPath security signature summary? tags
    apiParameters: ParameterInfo[]

    OpenAPI parameters (OpenAPI naming) for documentation.

    auth: AuthSummary
    className: string
    deprecated: boolean
    description?: string
    example: string

    Example execute code calling this method.

    httpMethod: string
    id: string

    Stable identifier: ".".

    inputType?: TypeDeclaration

    Request parameter interface, when the method takes one.

    methodName: string
    operationId?: string
    parameters: { name: string; optional: boolean; type: string }[]

    Parameter list as declared by the SDK.

    path: string
    referencedTypes: TypeDeclaration[]

    Declarations of SDK types referenced by inputs and outputs.

    requestBody?: {
        contentTypes: string[];
        description?: string;
        example?: unknown;
        required: boolean;
        schemaType: string;
    }
    requiredArguments: string[]

    Required argument names (SDK naming).

    responses: Record<string, string>
    returnType: string

    Declared return type, e.g. "Promise<Array>".

    sdkPath: string

    Exposed path in execute code, e.g. "sdk.PetsApi.listPets".

    security: SecurityRequirement[]
    signature: string

    Full method signature as declared by the SDK.

    summary?: string
    tags: string[]

    Settings
    Member Visibility

    On This Page
    Properties