# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Docusign Maestro Workflow Instance Management API
  version: 1.0.0
extends: openapi/docusign-workflow-instance-management-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/v1/accounts/{accountId}/management/instances/{instanceId}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running workflow instance
      effect: destructive
      questions:
      - How do I stop a Maestro workflow instance that's still running?
      - Can a workflow run be cancelled midway?
      instructions:
      - text: Cancel workflow instance {instance} in account {account}.
        slots:
          instance: path.instanceId
          account: path.accountId
      - text: Stop the running Maestro instance {instance} on account {account}.
        slots:
          instance: path.instanceId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{accountId}/management/workflow_definitions/{workflowDefinitionId}/config_instances'].get
  update:
    x-apievangelist-phrasing:
      intent: List configuration instances of a workflow
      effect: read
      questions:
      - What configuration instances exist for a workflow definition?
      - Where do I see the configs set up for a Maestro workflow?
      instructions:
      - text: List configuration instances for workflow {workflow} in account {account}.
        slots:
          workflow: path.workflowDefinitionId
          account: path.accountId
      - text: Show the config instances of workflow definition {workflow} on account {account}.
        slots:
          workflow: path.workflowDefinitionId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{accountId}/management/workflow_definitions/{workflowDefinitionId}/instances'].get
  update:
    x-apievangelist-phrasing:
      intent: List instances of a deployed workflow
      effect: read
      questions:
      - Which runs have been started for a deployed workflow?
      - Can I list all instances of one Maestro workflow definition?
      instructions:
      - text: List instances of workflow {workflow} in account {account}.
        slots:
          workflow: path.workflowDefinitionId
          account: path.accountId
      - text: Show every run of workflow definition {workflow} on account {account}.
        slots:
          workflow: path.workflowDefinitionId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{accountId}/management/workflow_definitions/{workflowDefinitionId}/instances/{instanceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a workflow instance
      effect: read
      questions:
      - How can I check the status of one specific workflow run?
      - What details are returned for a single workflow instance?
      instructions:
      - text: Get instance {instance} of workflow {workflow} in account {account}.
        slots:
          instance: path.instanceId
          workflow: path.workflowDefinitionId
          account: path.accountId
      - text: Show the status of run {instance} for workflow {workflow} on account {account}.
        slots:
          instance: path.instanceId
          workflow: path.workflowDefinitionId
          account: path.accountId
      method: generated
      generated: '2026-10-01'