Skip to main content

SdkManifestOperation

@webda/sdk

Interface: SdkManifestOperation

Defined in: sdk/src/manifest.ts:26

An operation of the manifest

Properties​

action?​

optional action?: object

Defined in: sdk/src/manifest.ts:40

global?​

optional global?: boolean

name​

name: string

behavior?​

optional behavior?: object

Defined in: sdk/src/manifest.ts:41

action​

action: string

attribute​

attribute: string

deprecated?​

optional deprecated?: boolean

Defined in: sdk/src/manifest.ts:47

description?​

optional description?: string

Defined in: sdk/src/manifest.ts:45

graphql?​

optional graphql?: GraphQLExposure

Defined in: sdk/src/manifest.ts:34

Where and how the GraphQLService exposes the operation, read from its schema

grpc?​

optional grpc?: object

Defined in: sdk/src/manifest.ts:36

The rpc of the operation, named as generateProto() does

rpc​

rpc: string

service​

service: string

id​

id: string

Defined in: sdk/src/manifest.ts:27

input​

input: string

Defined in: sdk/src/manifest.ts:29

Schema ref or void; <ref>? is a partial input (ignoreRequired)

kind?​

optional kind?: OperationKind

Defined in: sdk/src/manifest.ts:39

model?​

optional model?: string

Defined in: sdk/src/manifest.ts:38

Model id when the operation is CRUD, an action or a behavior of a model

output​

output: string

Defined in: sdk/src/manifest.ts:30

permission?​

optional permission?: string

Defined in: sdk/src/manifest.ts:43

WebdaQL on the session, informational

rest?​

optional rest?: object

Defined in: sdk/src/manifest.ts:32

method​

method: HttpMethod

path​

path: string

pathParams​

pathParams: string[]

query?​

optional query?: string[]

streaming​

streaming: OperationStreaming

Defined in: sdk/src/manifest.ts:31

summary?​

optional summary?: string

Defined in: sdk/src/manifest.ts:44

tags?​

optional tags?: string[]

Defined in: sdk/src/manifest.ts:46