# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure Purview Workflow Service Workflow Tasks API
  version: 1.0.0
extends: openapi/microsoft-azure-workflow-tasks-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: 6
- target: $.paths['/workflowtasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List workflow tasks
      effect: read
      questions:
      - Which approval and to-do tasks are waiting on me in my Purview workflows?
      - Can I filter workflow tasks by status, type, or a keyword in the workflow name?
      - Is there a way to only see tasks from a recent time window?
      instructions:
      - text: List my workflow tasks with status {statuses}.
        slots:
          statuses: query.taskStatuses
      - text: Show {task_types} workflow tasks from workflows whose names contain {keyword}.
        slots:
          task_types: query.taskTypes
          keyword: query.workflowNameKeyword
      - text: List workflow tasks in the last {time_window} ordered by {order_by}.
        slots:
          time_window: query.timeWindow
          order_by: query.orderby
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workflowtasks/{taskId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workflow task
      effect: read
      questions:
      - What is a specific workflow task asking me to do, and who requested it?
      - Can I pull up one workflow task by its id?
      instructions:
      - text: Get workflow task {task}.
        slots:
          task: path.taskId
      - text: Show the details and current status of task {task}.
        slots:
          task: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workflowtasks/{taskId}/approve-approval'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve an approval task
      effect: write
      questions:
      - How do I approve a pending approval request in a workflow?
      - Can I leave a comment when I approve a workflow approval task?
      instructions:
      - text: Approve approval task {task}.
        slots:
          task: path.taskId
      - text: Approve task {task} with the comment {comment}.
        slots:
          task: path.taskId
          comment: requestBody.comment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workflowtasks/{taskId}/reject-approval'].post
  update:
    x-apievangelist-phrasing:
      intent: Reject an approval task
      effect: destructive
      questions:
      - Can I turn down a workflow approval request that shouldn't go ahead?
      - Is it possible to explain why I rejected an approval task?
      instructions:
      - text: Reject approval task {task}.
        slots:
          task: path.taskId
      - text: Deny the approval request {task} and note {comment}.
        slots:
          task: path.taskId
          comment: requestBody.comment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workflowtasks/{taskId}/reassign'].post
  update:
    x-apievangelist-phrasing:
      intent: Reassign a workflow task to someone else
      effect: write
      questions:
      - Can I hand a workflow task off to a colleague while I'm out?
      - How are the new assignees specified when reassigning a workflow task?
      instructions:
      - text: Reassign workflow task {task} using {reassignments}.
        slots:
          task: path.taskId
          reassignments: requestBody.reassignments
      - text: Move task {task} off my plate to another assignee.
        slots:
          task: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workflowtasks/{taskId}/change-task-status'].post
  update:
    x-apievangelist-phrasing:
      intent: Change the status of a workflow task
      effect: write
      questions:
      - How do I mark a simple workflow task as in progress or completed?
      - Can I add a comment when changing a workflow task's status?
      instructions:
      - text: Change the status of workflow task {task} to {status}.
        slots:
          task: path.taskId
          status: requestBody.newStatus
      - text: Set task {task} to {status} and comment {comment}.
        slots:
          task: path.taskId
          status: requestBody.newStatus
          comment: requestBody.comment
      method: generated
      generated: '2026-10-01'