Interface CatalogOperation

Static operation metadata emitted by a provider catalog.

interface CatalogOperation {
    id: string;
    method: string;
    title?: string;
    description?: string;
    parameters?: CatalogParameter[];
    inputSchema?: CatalogSchema;
    outputSchema?: CatalogSchema;
    response?: CatalogResponseSpec;
    annotations?: OperationAnnotations;
    requiredScopes?: string[];
    tags?: string[];
    readOnly?: boolean;
    visible?: boolean;
    transport?: string;
    allowedRoles?: string[];
}

Index

Properties

id method title? description? parameters? inputSchema? outputSchema? response? annotations? requiredScopes? tags? readOnly? visible? transport? allowedRoles?

Properties

id

id: string

method

method: string

`Optional`title

title?: string

`Optional`description

description?: string

`Optional`parameters

parameters?: CatalogParameter[]

`Optional`inputSchema

inputSchema?: CatalogSchema

`Optional`outputSchema

outputSchema?: CatalogSchema

Deprecated

Replaced by CatalogOperation.response. Catalogs that still set outputSchema are treated as unary with the given schema.

`Optional`response

response?: CatalogResponseSpec

`Optional`annotations

annotations?: OperationAnnotations

`Optional`requiredScopes

requiredScopes?: string[]

`Optional`tags

tags?: string[]

`Optional`readOnly

readOnly?: boolean

`Optional`visible

visible?: boolean

`Optional`transport

transport?: string

`Optional`allowedRoles

allowedRoles?: string[]