Microsoft Purview · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Purview Workflow Workflow Run API

3 actions 3 updates phrasing extends openapi/microsoft-purview-workflow-run-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['/workflowruns/{workflowRunId}'].get

$.paths['/workflowruns/{workflowRunId}/cancel'].post

OpenAPI Overlay

# 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 Workflow Run API
  version: 1.0.0
extends: openapi/microsoft-purview-workflow-run-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['/workflowruns/{workflowRunId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workflow run
      effect: read
      questions:
      - What is the status of a particular workflow run?
      - Where can I see the progress of one workflow execution?
      instructions:
      - text: Show me workflow run {run}.
        slots:
          run: path.workflowRunId
      - text: Get the status of run {run}.
        slots:
          run: path.workflowRunId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workflowruns/{workflowRunId}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running workflow
      effect: destructive
      questions:
      - How do I stop a workflow run that is in progress?
      - Can I record a reason when cancelling a workflow run?
      instructions:
      - text: Cancel workflow run {run}.
        slots:
          run: path.workflowRunId
      - text: Cancel run {run} with the comment {comment}.
        slots:
          run: path.workflowRunId
          comment: requestBody.comment
      method: generated
      generated: '2026-10-01'