Skip to main content

OperationDefinitionInfo

@webda/core

Interface: OperationDefinitionInfo

Defined in: packages/core/src/core/icore.ts:205

Define an operation within webda app

Extends​

Properties​

context?​

optional context?: any

Defined in: packages/core/src/core/icore.ts:129

Context to use for the operation

Useful to define a specific context for the operation

Inherited from​

OperationDefinition.context

deprecated?​

optional deprecated?: boolean

Defined in: packages/core/src/core/icore.ts:145

Mark the operation as deprecated

Inherited from​

OperationDefinition.deprecated

description?​

optional description?: string

Defined in: packages/core/src/core/icore.ts:137

Full description of the operation

Inherited from​

OperationDefinition.description

extensions?​

optional extensions?: Record<string, unknown>

Defined in: packages/core/src/core/icore.ts:186

Additional transport hints for future extensibility

Inherited from​

OperationDefinition.extensions

graphql?​

optional graphql?: false | { mutation?: string; query?: string; subscription?: string; }

Defined in: packages/core/src/core/icore.ts:175

GraphQL transport hints

Set to false to explicitly exclude from GraphQL transport. Provide an object to specify query, mutation, or subscription mappings.

Inherited from​

OperationDefinition.graphql

grpc?​

optional grpc?: false | { streaming?: "none" | "client" | "server" | "bidi"; }

Defined in: packages/core/src/core/icore.ts:168

gRPC transport hints

Set to false to explicitly exclude from gRPC transport. Provide an object to specify streaming mode.

Inherited from​

OperationDefinition.grpc

hidden?​

optional hidden?: boolean

Defined in: packages/core/src/core/icore.ts:149

Hide the operation from transport exposure

Inherited from​

OperationDefinition.hidden

id​

id: string

Defined in: packages/core/src/core/icore.ts:94

Id of the operation

Inherited from​

OperationDefinition.id

input​

input: string

Defined in: packages/core/src/core/icore.ts:98

Schema name for operation input. Use "void" for no input.

Inherited from​

OperationDefinition.input

mcp?​

optional mcp?: false | { destructive?: boolean; readOnly?: boolean; title?: string; }

Defined in: packages/core/src/core/icore.ts:182

MCP transport hints

Set to false to explicitly exclude from the MCP transport. Provide an object to set the tool title or override the read-only/destructive hints.

Union Members​

false

Type Literal​

{ destructive?: boolean; readOnly?: boolean; title?: string; }

destructive?​

optional destructive?: boolean

Override the derived destructiveHint

readOnly?​

optional readOnly?: boolean

Override the derived readOnlyHint

title?​

optional title?: string

Human-friendly tool title

Inherited from​

OperationDefinition.mcp

method​

method: string

Defined in: packages/core/src/core/icore.ts:123

Method implementing the operation

Inherited from​

OperationDefinition.method

model?​

optional model?: string

Defined in: packages/core/src/core/icore.ts:119

Model implementing the operation

Either service or model should be defined

Inherited from​

OperationDefinition.model

output​

output: string

Defined in: packages/core/src/core/icore.ts:102

Schema name for operation output. Use "void" for no output.

Inherited from​

OperationDefinition.output

permission?​

optional permission?: WebdaQLString<unknown>

Defined in: packages/core/src/core/icore.ts:107

WebdaQL to execute on session to know if operation is available to user

Inherited from​

OperationDefinition.permission

permissionQuery?​

optional permissionQuery?: QueryValidator

Defined in: packages/core/src/core/icore.ts:209

Contains the parse permission query

rest?​

optional rest?: false | { method: "get" | "post" | "put" | "delete" | "patch"; path: string; responses?: {[statusCode: string]: object; }; }

Defined in: packages/core/src/core/icore.ts:161

REST transport hints

Set to false to explicitly exclude from REST transport. Provide an object to specify REST method, path, and response definitions.

Inherited from​

OperationDefinition.rest

service?​

optional service?: string

Defined in: packages/core/src/core/icore.ts:113

Service implementing the operation

Either service or model should be defined

Inherited from​

OperationDefinition.service

static?​

optional static?: boolean

Defined in: packages/core/src/core/icore.ts:154

Whether this is a static (class-level) or instance method Used by callOperation to determine if model instance needs to be loaded

Inherited from​

OperationDefinition.static

summary?​

optional summary?: string

Defined in: packages/core/src/core/icore.ts:133

Short summary of the operation

Inherited from​

OperationDefinition.summary

tags?​

optional tags?: string[]

Defined in: packages/core/src/core/icore.ts:141

Categorization tags for the operation

Inherited from​

OperationDefinition.tags