Interface CatalogOperation

CatalogOperation is one executable operation exposed by an integration provider.

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

Index

Properties

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

Properties

id

id: string

method

method: string

title

title: string

description

description: string

inputSchema

inputSchema: string

`Optional`annotations

annotations?: OperationAnnotations

parameters

parameters: CatalogParameter[]

requiredScopes

requiredScopes: string[]

tags

tags: string[]

readOnly

readOnly: boolean

`Optional`visible

visible?: boolean

transport

transport: string

allowedRoles

allowedRoles: string[]

`Optional`response

response?: OperationResponseSpec

Response mode and schema for this operation. Replaces the former output_schema string; absent is equivalent to unary with no schema.