dag-api / Exports / DagDesignController

Class: DagDesignController

API controller for DAG definition lifecycle: create, update, validate, publish, and list.

See

DagDefinitionService

Table of contents

Constructors

• constructor

Methods

• createDefinition
• updateDraft
• validateDefinition
• publishDefinition
• getDefinition
• listDefinitions
• listNodeCatalog

Constructors

constructor

• new DagDesignController(definitionService, nodeCatalogService?): DagDesignController

Parameters

Name	Type
definitionService	DagDefinitionService
nodeCatalogService?	INodeCatalogService

Returns

DagDesignController

Defined in

controllers/dag-design-controller.ts:27

Methods

createDefinition

▸ createDefinition(request): Promise<TDesignApiResponse<{ definitionId: string ; definition: IDagDefinition }>>

Parameters

Name	Type
request	ICreateDefinitionRequest

Returns

Promise<TDesignApiResponse<{ definitionId: string ; definition: IDagDefinition }>>

Defined in

controllers/dag-design-controller.ts:32

---

updateDraft

▸ updateDraft(request): Promise<TDesignApiResponse<{ definition: IDagDefinition }>>

Parameters

Name	Type
request	IUpdateDraftRequest

Returns

Promise<TDesignApiResponse<{ definition: IDagDefinition }>>

Defined in

controllers/dag-design-controller.ts:43

---

validateDefinition

▸ validateDefinition(request): Promise<TDesignApiResponse<IDefinitionValidationResult>>

Parameters

Name	Type
request	IValidateDefinitionRequest

Returns

Promise<TDesignApiResponse<IDefinitionValidationResult>>

Defined in

controllers/dag-design-controller.ts:54

---

publishDefinition

▸ publishDefinition(request): Promise<TDesignApiResponse<{ definitionId: string ; definition: IDagDefinition }>>

Parameters

Name	Type
request	IPublishDefinitionRequest

Returns

Promise<TDesignApiResponse<{ definitionId: string ; definition: IDagDefinition }>>

Defined in

controllers/dag-design-controller.ts:99

---

getDefinition

▸ getDefinition(request): Promise<TDesignApiResponse<{ definition: IDagDefinition }>>

Parameters

Name	Type
request	IGetDefinitionRequest

Returns

Promise<TDesignApiResponse<{ definition: IDagDefinition }>>

Defined in

controllers/dag-design-controller.ts:110

---

listDefinitions

▸ listDefinitions(request): Promise<TDesignApiResponse<{ items: IDefinitionListItem[] }>>

Parameters

Name	Type
request	IListDefinitionsRequest

Returns

Promise<TDesignApiResponse<{ items: IDefinitionListItem[] }>>

Defined in

controllers/dag-design-controller.ts:122

---

listNodeCatalog

▸ listNodeCatalog(request): Promise<TDesignApiResponse<{ nodes: INodeManifest[] }>>

Parameters

Name	Type
request	IListNodeCatalogRequest

Returns

Promise<TDesignApiResponse<{ nodes: INodeManifest[] }>>

Defined in

controllers/dag-design-controller.ts:158