Microsoft Purview · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Purview Workflow Approval API

3 actions 3 updates phrasing extends openapi/microsoft-purview-approval-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Microsoft Purview's API. It is a proposal applied on top of the contract, not a document Microsoft Purview publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/approvals/{taskId}/approve'].post
$.paths['/approvals/{taskId}/reject'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Purview Workflow Approval API
  version: 1.0.0
extends: openapi/microsoft-purview-approval-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: 2
- target: $.paths['/approvals/{taskId}/approve'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve a workflow approval task
      effect: write
      questions:
      - What's the way to approve a pending Purview workflow approval request?
      - Can I leave a comment when I sign off on an approval task?
      instructions:
      - text: Approve workflow 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['/approvals/{taskId}/reject'].post
  update:
    x-apievangelist-phrasing:
      intent: Reject a workflow approval task
      effect: write
      questions:
      - Is it possible to turn down an approval request in a Purview workflow?
      - Can I explain why I declined an approval task?
      instructions:
      - text: Reject workflow approval task {task}.
        slots:
          task: path.taskId
      - text: Decline approval {task} and note {comment} as the reason.
        slots:
          task: path.taskId
          comment: requestBody.comment
      method: generated
      generated: '2026-10-01'