# 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 Management API
  version: 1.0.0
extends: openapi/docusign-workflow-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: 7
- target: $.paths['/v1/accounts/{accountId}/management/instances/{instanceId}/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the step history of a workflow instance
      effect: read
      questions:
      - Which steps has a running Maestro workflow instance already completed?
      - Can I see the step-by-step history of a workflow run?
      instructions:
      - text: Show the step history for workflow instance {instance} in account {account}.
        slots:
          instance: path.instanceId
          account: path.accountId
      - text: Get the history of 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'].get
  update:
    x-apievangelist-phrasing:
      intent: List workflow definitions
      effect: read
      questions:
      - What Maestro workflow definitions exist in my account?
      - Can I filter workflow definitions by their status?
      instructions:
      - text: List workflow definitions in account {account}.
        slots:
          account: path.accountId
      - text: Show {status} workflow definitions for account {account}.
        slots:
          status: query.status
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{accountId}/management/workflow_definitions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a workflow definition
      effect: write
      questions:
      - Can I create a Maestro workflow definition through the API instead of the web UI?
      - What do I send to define a new workflow?
      instructions:
      - text: Create a workflow definition in account {account} from {definition}.
        slots:
          account: path.accountId
          definition: requestBody.workflowDefinition
      - text: 'Add this new Maestro workflow definition to account {account}: {definition}.'
        slots:
          account: path.accountId
          definition: requestBody.workflowDefinition
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{accountId}/management/workflow_definitions/{workflowDefinitionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workflow definition
      effect: read
      questions:
      - How do I fetch the full definition of one Maestro workflow?
      - Can I retrieve the last deployed version of a workflow definition?
      instructions:
      - text: Get workflow definition {workflow} in account {account}.
        slots:
          workflow: path.workflowDefinitionId
          account: path.accountId
      - text: Show deployed version {deployed} of workflow {workflow} in account {account}.
        slots:
          deployed: query.lastDeployedId
          workflow: path.workflowDefinitionId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{accountId}/management/workflow_definitions/{workflowDefinitionId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a workflow definition
      effect: write
      questions:
      - Can I edit an existing Maestro workflow definition via the API?
      - How do I change the steps of a workflow I already defined?
      instructions:
      - text: Update workflow definition {workflow} in account {account} with {definition}.
        slots:
          workflow: path.workflowDefinitionId
          account: path.accountId
          definition: requestBody.workflowDefinition
      - text: Replace the definition of workflow {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}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a workflow definition
      effect: destructive
      questions:
      - How do I delete a Maestro workflow definition?
      - Can I remove a workflow definition I no longer use?
      instructions:
      - text: Delete workflow definition {workflow} from account {account}.
        slots:
          workflow: path.workflowDefinitionId
          account: path.accountId
      - text: Remove Maestro workflow {workflow} in account {account}.
        slots:
          workflow: path.workflowDefinitionId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{accountId}/management/workflow_definitions/{workflowDefinitionId}/publish'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish or unpublish a workflow definition
      effect: write
      questions:
      - How do I publish a workflow so it can be triggered?
      - Can I unpublish a Maestro workflow without deleting it?
      instructions:
      - text: Set workflow {workflow} in account {account} to deployment status {deploy}.
        slots:
          workflow: path.workflowDefinitionId
          account: path.accountId
          deploy: requestBody.deploymentStatus
      - text: Publish workflow definition {workflow} on account {account} with status {deploy}.
        slots:
          workflow: path.workflowDefinitionId
          account: path.accountId
          deploy: requestBody.deploymentStatus
      method: generated
      generated: '2026-10-01'