Skip to content

Commit 19aa901

Browse files
garg-muditgarg-mudit
committed
TIR - Updated maestro.rest.swagger-v1.0.0.json
1 parent 9045f99 commit 19aa901

File tree

1 file changed

+44
-63
lines changed

1 file changed

+44
-63
lines changed

‎maestro.rest.swagger-v1.0.0.json‎

Lines changed: 44 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@
6868
],
6969
"get": {
7070
"operationId": "GetWorkflowsList",
71-
"summary": "",
72-
"description": "",
71+
"summary": "Retrieve a list of available Maestro workflows",
72+
"description": "This operation retrieves a list of all available Maestro workflows. It returns basic information\nabout each workflow, including its unique identifier (`id`), name, description, and the input\nschema required to trigger the workflow.\n\nThe response provides key details that help users identify which workflows are available\nand understand the input requirements for triggering each one. Each workflow entry also includes\nmetadata, such as when it was created, last modified, and by whom.\n\nThis operation is useful for obtaining an overview of all workflows within the system, helping\nusers and systems know what workflows are defined, what inputs they require, and how they can\nbe triggered.\n\n### Use Cases:\n- Listing all available workflows in a system for manual or automated workflow initiation.\n- Reviewing the input requirements for a workflow before triggering it programmatically.\n- Gathering basic metadata about workflows for auditing, logging, or reporting purposes.\n\n### Key Features:\n- **Comprehensive Workflow Overview**: Provides a full list of workflows, giving visibility\n into all the automated processes available within the Maestro platform.\n- **Input Schema Information**: Each workflow includes its trigger input schema, showing\n what data must be provided when triggering the workflow.\n- **Metadata for Tracking**: Useful metadata like creation time, last modification date,\n and user details are included to support tracking and auditing workflows.\n- **Future-Proof**: The operation is designed to be expandable as more workflows are added\n or the platform grows, ensuring scalability in the workflow management process.\n",
7373
"x-ds-methodname": "getWorkflowsList",
7474
"tags": [
7575
"Workflows"
@@ -95,8 +95,7 @@
9595
}
9696
},
9797
"x-ds-method": "getWorkflowsList",
98-
"x-ds-service": "Maestro",
99-
"x-ds-in-sdk": true
98+
"x-ds-service": "Maestro"
10099
}
101100
},
102101
"/v1/accounts/{accountId}/workflows/{workflowId}/trigger-requirements": {
@@ -114,16 +113,15 @@
114113
],
115114
"get": {
116115
"operationId": "GetWorkflowTriggerRequirements",
117-
"summary": "",
118-
"description": "",
116+
"summary": "Retrieve trigger requirements for a specific Maestro workflow",
117+
"description": "This operation retrieves the configuration and input requirements necessary to trigger a specific\nMaestro workflow. It provides detailed information about the `trigger_event_type`, such as HTTP\nor other supported types, and specifies the required input schema, including field names, data types,\nand any default values.\n\nThis information is essential for understanding the data and parameters required to initiate the\nworkflow. It enables developers to prepare the necessary inputs and configuration before triggering\nthe workflow instance, ensuring seamless execution and compliance with workflow requirements.\n\n### Use Cases:\n- Identifying the required input fields and their data types to successfully trigger the workflow.\n- Reviewing the trigger configuration for validation and compliance with expected input.\n- Preparing and validating data in advance of triggering the workflow, minimizing runtime errors.\n\n### Key Features:\n- **Detailed Trigger Input Requirements**: Provides an exhaustive schema of required fields,\n their data types, and optional default values for easy reference and data validation.\n- **Trigger Event Type Information**: Specifies the type of event required to initiate the workflow\n (e.g., HTTP), helping developers configure their systems to invoke the workflow appropriately.\n- **Configurable for Custom Triggers**: Suitable for custom configurations, enabling flexibility\n in how workflows can be triggered according to system needs.\n",
119118
"x-ds-methodname": "getWorkflowTriggerRequirements",
120119
"tags": [
121120
"Workflows"
122121
],
123122
"parameters": [
124123
{
125-
"$ref": "#/components/parameters/WorkflowId",
126-
"description": ""
124+
"$ref": "#/components/parameters/WorkflowId"
127125
}
128126
],
129127
"responses": {
@@ -147,8 +145,7 @@
147145
}
148146
},
149147
"x-ds-method": "getWorkflowTriggerRequirements",
150-
"x-ds-service": "Maestro",
151-
"x-ds-in-sdk": true
148+
"x-ds-service": "Maestro"
152149
}
153150
},
154151
"/v1/accounts/{accountId}/workflows/{workflowId}/actions/trigger": {
@@ -166,16 +163,15 @@
166163
],
167164
"post": {
168165
"operationId": "TriggerWorkflow",
169-
"summary": "",
170-
"description": "",
166+
"summary": "Trigger a new instance of a Maestro workflow",
167+
"description": "This operation triggers a new instance of a specified Maestro workflow. When invoked,\nthe workflow is started based on the provided input data, and the workflow instance\nbegins executing according to its defined logic and configuration.\n\nThe request requires an `instance_name` and any input data necessary to start the workflow,\nas described by the workflow's `trigger_input_schema`. The `instance_name` is a user-defined\nlabel for tracking the workflow run, while the input data fields should match the schema defined\nin the workflow.\n\nThe operation is event-driven and typically triggered by an external HTTP event or system call,\nallowing for the automatic execution of complex processes that span multiple systems or components.\n\nUpon successful execution, the response returns the unique identifier (`id`) for the newly\ncreated workflow instance, along with a URL (`workflow_instance_url`) that can be used to\ninteract with or track the running instance.\n\n### Use Cases:\n- Automating user registration workflows where input fields like `name` and `email` are provided.\n- Processing financial transactions where details such as `amount` and `currency` are required.\n- Sending notifications based on user interactions in other systems.\n\n### Key Features:\n- **Automated Execution**: Once triggered, the workflow runs until a step requires manual intervention.\n- **Input-Driven**: Workflow execution is based on the provided input data, which is validated\n against the workflow's input schema.\n- **Real-Time Triggering**: Designed to be invoked as part of an event-driven architecture,\n allowing for workflows to respond to external events.\n- **Tracking and Interaction**: The response includes a URL that allows users to check the status\n of the workflow instance or take further actions while it runs.\n",
171168
"x-ds-methodname": "triggerWorkflow",
172169
"tags": [
173170
"Workflows"
174171
],
175172
"parameters": [
176173
{
177-
"$ref": "#/components/parameters/WorkflowId",
178-
"description": ""
174+
"$ref": "#/components/parameters/WorkflowId"
179175
}
180176
],
181177
"requestBody": {
@@ -202,8 +198,7 @@
202198
}
203199
},
204200
"x-ds-method": "triggerWorkflow",
205-
"x-ds-service": "Maestro",
206-
"x-ds-in-sdk": true
201+
"x-ds-service": "Maestro"
207202
}
208203
},
209204
"/v1/accounts/{accountId}/workflows/{workflowId}/instances": {
@@ -219,17 +214,16 @@
219214
}
220215
],
221216
"get": {
222-
"summary": "",
223-
"description": "",
217+
"summary": "Retrieve All Workflow Instances",
218+
"description": "This operation retrieves a list of all available Maestro workflow instances. It returns basic information\nabout each workflow instance, including its unique identifier (`id`), name, status, timestamps, and\nadditional metadata.\n\nThe response provides key details that help users understand what workflow instances are in progress\nor completed, and the relevant data for each. Each workflow instance entry also includes metadata, such\nas who started it, when it was last modified, and how many steps have been completed.\n\n### Use Cases:\n- Listing all available workflow instances for manual or automated review\n- Monitoring which workflow instances are currently running or have finished\n- Gathering basic metadata about workflow instances for auditing, logging, or reporting purposes\n\n### Key Features:\n- **Comprehensive Instance Overview**: Provides a full list of workflow instances, giving visibility\n into all ongoing and completed workflows within the Maestro platform\n- **Metadata for Tracking**: Includes helpful metadata like creation time, last modification date,\n and user details to support audit trails\n- **Scalable and Future-Proof**: Designed to handle growing numbers of workflow instances as the\n platform scales\n",
224219
"operationId": "getWorkflowInstancesList",
225220
"x-ds-methodname": "getWorkflowInstancesList",
226221
"tags": [
227222
"WorkflowInstanceManagement"
228223
],
229224
"parameters": [
230225
{
231-
"$ref": "#/components/parameters/WorkflowId",
232-
"description": ""
226+
"$ref": "#/components/parameters/WorkflowId"
233227
}
234228
],
235229
"responses": {
@@ -250,27 +244,24 @@
250244
}
251245
},
252246
"x-ds-method": "getWorkflowInstancesList",
253-
"x-ds-service": "Maestro",
254-
"x-ds-in-sdk": true
247+
"x-ds-service": "Maestro"
255248
}
256249
},
257250
"/v1/accounts/{accountId}/workflows/{workflowId}/actions/pause": {
258251
"post": {
259-
"summary": "",
260-
"description": "",
252+
"summary": "Pause an Active Workflow",
253+
"description": "This operation pauses new workflow instances from being created. Any running workflows instances will be unaffected.\n",
261254
"operationId": "pauseNewWorkflowInstances",
262255
"x-ds-methodname": "pauseNewWorkflowInstances",
263256
"tags": [
264257
"Workflows"
265258
],
266259
"parameters": [
267260
{
268-
"$ref": "#/components/parameters/AccountId",
269-
"description": ""
261+
"$ref": "#/components/parameters/AccountId"
270262
},
271263
{
272-
"$ref": "#/components/parameters/WorkflowId",
273-
"description": ""
264+
"$ref": "#/components/parameters/WorkflowId"
274265
}
275266
],
276267
"responses": {
@@ -297,27 +288,24 @@
297288
}
298289
},
299290
"x-ds-method": "pauseNewWorkflowInstances",
300-
"x-ds-service": "Maestro",
301-
"x-ds-in-sdk": true
291+
"x-ds-service": "Maestro"
302292
}
303293
},
304294
"/v1/accounts/{accountId}/workflows/{workflowId}/actions/resume": {
305295
"post": {
306-
"summary": "",
307-
"description": "",
296+
"summary": "Resume a Paused Workflow",
297+
"description": "This operation enables new workflow instances to be created\n",
308298
"operationId": "resumePausedWorkflow",
309299
"x-ds-methodname": "resumePausedWorkflow",
310300
"tags": [
311301
"Workflows"
312302
],
313303
"parameters": [
314304
{
315-
"$ref": "#/components/parameters/AccountId",
316-
"description": ""
305+
"$ref": "#/components/parameters/AccountId"
317306
},
318307
{
319-
"$ref": "#/components/parameters/WorkflowId",
320-
"description": ""
308+
"$ref": "#/components/parameters/WorkflowId"
321309
}
322310
],
323311
"responses": {
@@ -344,8 +332,7 @@
344332
}
345333
},
346334
"x-ds-method": "resumePausedWorkflow",
347-
"x-ds-service": "Maestro",
348-
"x-ds-in-sdk": true
335+
"x-ds-service": "Maestro"
349336
}
350337
},
351338
"/v1/accounts/{accountId}/workflows/{workflowId}/instances/{instanceId}": {
@@ -361,21 +348,19 @@
361348
}
362349
],
363350
"get": {
364-
"summary": "Gets the details for a specific instance for a deployed workflow definition.",
365-
"description": "Gets the details for a specific instance for a deployed workflow definition.\n\n<!-- maestro beta notice -->\n\n<ds-inlinemessage>\n The Maestro API is currently only available\n as part of a beta program.\n See <a href=\"/docs/maestro-api/get-access/\">Get access to Maestro API</a>\n for details.\n</ds-inlinemessage>\n\n<!-- end maestro beta notice -->\n\n\n### Related topics\n\n- [How to get the status of a Maestro workflow instance][howto-status]\n\n[howto-status]: /docs/maestro-api/how-to/get-workflow-status/\n",
351+
"summary": "Retrieve a Workflow Instance",
352+
"description": "This operation retrieves a single Maestro workflow instance by its unique identifier (`id`).\nIt returns the primary details of the workflow instance, including its name, status,\nstarting information, and other metadata.\n\nThe response provides key details that help users understand the current state of the workflow\ninstance, when it was started, and who initiated it. Additional metadata is included to support\nauditing and reporting within the system.\n\n### Use Cases:\n- Getting the details of a specific workflow instance for further processing or review\n- Monitoring the status of a running workflow instance to determine completion or cancellation\n- Accessing metadata for auditing, logging, or reporting on a single workflow instance\n\n### Key Features:\n- **Single Workflow Instance**: Provides direct access to a specific workflow instance by `id`\n- **Detailed Status Information**: Includes the workflow's start and end times, status, and other lifecycle timestamps\n- **Metadata for Tracking**: Useful metadata like who initiated the workflow (`started_by`) and versioning details\n- **Future-Proof**: Designed to be extensible if additional fields or nested information are required over time\n",
366353
"operationId": "getWorkflowInstance",
367354
"x-ds-methodname": "getWorkflowInstance",
368355
"tags": [
369356
"WorkflowInstanceManagement"
370357
],
371358
"parameters": [
372359
{
373-
"$ref": "#/components/parameters/WorkflowId",
374-
"description": ""
360+
"$ref": "#/components/parameters/WorkflowId"
375361
},
376362
{
377-
"$ref": "#/components/parameters/InstanceId",
378-
"description": ""
363+
"$ref": "#/components/parameters/InstanceId"
379364
}
380365
],
381366
"responses": {
@@ -411,8 +396,7 @@
411396
}
412397
},
413398
"x-ds-method": "getWorkflowInstance",
414-
"x-ds-service": "Maestro",
415-
"x-ds-in-sdk": true
399+
"x-ds-service": "Maestro"
416400
}
417401
},
418402
"/v1/accounts/{accountId}/workflows/{workflowId}/instances/{instanceId}/actions/cancel": {
@@ -428,21 +412,19 @@
428412
}
429413
],
430414
"post": {
431-
"summary": "Cancels a running workflow instance.",
432-
"description": "Cancels a running \n[workflow][workflows-concept]\ninstance.\n\n<!-- maestro beta notice -->\n\n<ds-inlinemessage>\n The Maestro API is currently only available\n as part of a beta program.\n See <a href=\"/docs/maestro-api/get-access/\">Get access to Maestro API</a>\n for details.\n</ds-inlinemessage>\n\n<!-- end maestro beta notice -->\n\n### Related topics\n\n- [How to cancel a Maestro workflow instance][howto-cancel]\n\n\n[howto-cancel]: /docs/maestro-api/how-to/cancel-workflow/\n[workflows-concept]: /docs/maestro-api/maestro101/workflows/",
415+
"summary": "Cancel a Running Workflow Instance",
416+
"description": "This operation cancels a running Maestro workflow instance by its unique identifier (`instanceId`).\nOnce canceled, the workflow instance will no longer continue executing any remaining steps.\n\n### Use Cases:\n- Stopping a workflow execution when it is no longer needed or relevant\n- Manually intervening in a workflow to prevent it from reaching completion if conditions change\n\n### Key Features:\n- **Immediate Termination**: Ensures the workflow instance no longer processes subsequent steps\n- **Clear Feedback**: Returns a confirmation message including both the instance and workflow identifiers\n",
433417
"operationId": "cancelWorkflowInstance",
434418
"x-ds-methodname": "cancelWorkflowInstance",
435419
"tags": [
436420
"WorkflowInstanceManagement"
437421
],
438422
"parameters": [
439423
{
440-
"$ref": "#/components/parameters/WorkflowId",
441-
"description": ""
424+
"$ref": "#/components/parameters/WorkflowId"
442425
},
443426
{
444-
"$ref": "#/components/parameters/InstanceId",
445-
"description": ""
427+
"$ref": "#/components/parameters/InstanceId"
446428
}
447429
],
448430
"responses": {
@@ -469,8 +451,7 @@
469451
}
470452
},
471453
"x-ds-method": "cancelWorkflowInstance",
472-
"x-ds-service": "Maestro",
473-
"x-ds-in-sdk": true
454+
"x-ds-service": "Maestro"
474455
}
475456
}
476457
},
@@ -1494,15 +1475,15 @@
14941475
"tags": [
14951476
{
14961477
"name": "WorkflowTrigger",
1497-
"description": "Method to trigger a workflow."
1478+
"description": ""
14981479
},
14991480
{
15001481
"name": "WorkflowInstanceManagement",
1501-
"description": "Methods to get information about workflow instances."
1482+
"description": ""
15021483
},
15031484
{
15041485
"name": "WorkflowManagement",
1505-
"description": "Returns the history of the workflow instance steps."
1486+
"description": ""
15061487
},
15071488
{
15081489
"name": "Workflows",
@@ -1512,18 +1493,18 @@
15121493
"x-ds-categories": [
15131494
{
15141495
"name": "WorkflowTrigger",
1515-
"summary": "Method to trigger a workflow.",
1516-
"description": "Method to trigger a workflow."
1496+
"summary": "",
1497+
"description": ""
15171498
},
15181499
{
15191500
"name": "WorkflowInstanceManagement",
1520-
"summary": "Methods to get information about workflow instances.",
1521-
"description": "Methods to get information about workflow instances."
1501+
"summary": "",
1502+
"description": ""
15221503
},
15231504
{
15241505
"name": "WorkflowManagement",
1525-
"summary": "Methods to create, retrieve, update, and delete workflow definitions.",
1526-
"description": "Methods to create, retrieve, update, and delete workflow definitions."
1506+
"summary": "",
1507+
"description": ""
15271508
},
15281509
{
15291510
"name": "Maestro",

0 commit comments

Comments
 (0)