bpmn-server / Operation
Interface: Operation#
Table of contents#
Properties#
Properties#
operationId#
• operationId: string
Defined in#
packages/bpmn-server/src/connectors/OpenAPI.ts:18
method#
• method: string
Defined in#
packages/bpmn-server/src/connectors/OpenAPI.ts:19
path#
• path: string
Defined in#
packages/bpmn-server/src/connectors/OpenAPI.ts:20
summary#
• Optional summary: string
Defined in#
packages/bpmn-server/src/connectors/OpenAPI.ts:21
description#
• Optional description: string
Defined in#
packages/bpmn-server/src/connectors/OpenAPI.ts:22
parameters#
• parameters: OperationParameter[]
Defined in#
packages/bpmn-server/src/connectors/OpenAPI.ts:23
body#
• Optional body: Object
the JSON request body, when the operation takes one
Type declaration#
| Name | Type |
|---|---|
required |
boolean |
schema? |
any |
contentType |
string |
Defined in#
packages/bpmn-server/src/connectors/OpenAPI.ts:25
responses#
• responses: Record\<string, { description?: string ; schema?: any }>
the responses by status ('200', '404', 'default'): their description and JSON schema
Defined in#
packages/bpmn-server/src/connectors/OpenAPI.ts:27
security#
• Optional security: string[]
the security requirements (names of securitySchemes); none given: the document's
Defined in#
packages/bpmn-server/src/connectors/OpenAPI.ts:29