Microsoft Purview · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Purview Workflow API

5 actions 5 updates phrasing extends openapi/microsoft-purview-workflow-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 5

$.info
$.paths['/workflows/{workflowId}'].get
$.paths['/workflows/{workflowId}'].put
$.paths['/workflows/{workflowId}'].delete
$.paths['/workflows/{workflowId}/validate'].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 API
  version: 1.0.0
extends: openapi/microsoft-purview-workflow-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['/workflows/{workflowId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workflow definition
      effect: read
      questions:
      - What triggers and actions are in a specific Purview workflow?
      - Is a particular workflow enabled?
      instructions:
      - text: Show me workflow {workflow}.
        slots:
          workflow: path.workflowId
      - text: Get the definition of workflow {workflow}.
        slots:
          workflow: path.workflowId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workflows/{workflowId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a workflow
      effect: write
      questions:
      - How do I create an approval workflow in Purview?
      - Can I overwrite an existing workflow's triggers and actions?
      instructions:
      - text: Create workflow {workflow} named {name} with triggers {triggers}.
        slots:
          workflow: path.workflowId
          name: requestBody.name
          triggers: requestBody.triggers
      - text: Replace workflow {workflow} with action graph {dag}.
        slots:
          workflow: path.workflowId
          dag: requestBody.actionDag
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workflows/{workflowId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a workflow
      effect: destructive
      questions:
      - Can I remove a workflow that is no longer used?
      - What is the way to delete a workflow by ID?
      instructions:
      - text: Delete workflow {workflow}.
        slots:
          workflow: path.workflowId
      - text: Remove the {workflow} workflow.
        slots:
          workflow: path.workflowId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workflows/{workflowId}/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a workflow definition
      effect: read
      questions:
      - How can I check a workflow definition for errors before saving it?
      - Will my workflow's triggers and actions pass validation?
      instructions:
      - text: Validate workflow {workflow} with triggers {triggers} without saving it.
        slots:
          workflow: path.workflowId
          triggers: requestBody.triggers
      - text: Dry-run check workflow {workflow} using action graph {dag}.
        slots:
          workflow: path.workflowId
          dag: requestBody.actionDag
      method: generated
      generated: '2026-10-01'