# 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 Workflow Runs API
  version: 1.0.0
extends: openapi/microsoft-azure-workflow-runs-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: 10
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List runs of a Logic Apps workflow
      effect: read
      questions:
      - Which runs has my Logic Apps workflow executed recently?
      - Can I filter a consumption Logic App's run history, say to failed runs only?
      instructions:
      - text: List runs of Logic App workflow {workflow} in resource group {rg} of subscription {sub}.
        slots:
          workflow: path.workflowName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show the last {top} runs of Logic App {workflow} matching {filter}.
        slots:
          top: query.$top
          workflow: path.workflowName
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Logic Apps workflow run
      effect: read
      questions:
      - What happened in a specific run of my Logic App?
      - Where do I see the status and timing of a single consumption Logic Apps run?
      instructions:
      - text: Get run {run} of Logic App workflow {workflow} in resource group {rg} of subscription {sub}.
        slots:
          run: path.runName
          workflow: path.workflowName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show Logic App {workflow}'s run {run}.
        slots:
          workflow: path.workflowName
          run: path.runName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Logic Apps workflow run
      effect: destructive
      questions:
      - Can I delete a run record from a Logic App's history?
      - How do I remove one old Logic Apps run?
      instructions:
      - text: Delete run {run} of Logic App workflow {workflow} in resource group {rg} of subscription {sub}.
        slots:
          run: path.runName
          workflow: path.workflowName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Erase Logic App {workflow} run {run} from history.
        slots:
          workflow: path.workflowName
          run: path.runName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running Logic Apps run
      effect: destructive
      questions:
      - How do I stop a consumption Logic App run that is stuck in progress?
      - Can I cancel one in-flight run of a Logic Apps workflow?
      instructions:
      - text: Cancel run {run} of Logic App workflow {workflow} in resource group {rg} of subscription {sub}.
        slots:
          run: path.runName
          workflow: path.workflowName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Abort the in-progress Logic App {workflow} run {run}.
        slots:
          workflow: path.workflowName
          run: path.runName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workflowruns'].get
  update:
    x-apievangelist-phrasing:
      intent: List data-plane workflow runs
      effect: read
      questions:
      - Which workflow runs happened in a given time window?
      - Can I list only workflow runs with certain statuses or for specific workflow ids?
      instructions:
      - text: List workflow runs in time window {window} with statuses {statuses}.
        slots:
          window: query.timeWindow
          statuses: query.runStatuses
      - text: Show runs for workflows {workflow_ids} ordered by {orderby}.
        slots:
          workflow_ids: query.workflowIds
          orderby: query.orderby
      - text: List my recent workflow runs across all workflows.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workflowruns/{workflowRunId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workflow run by its run id
      effect: read
      questions:
      - What is the status of a workflow run when I only have its run id?
      - Where do I fetch one workflow run without naming its workflow?
      instructions:
      - text: Get workflow run {run_id}.
        slots:
          run_id: path.workflowRunId
      - text: Show details and status for run id {run_id}.
        slots:
          run_id: path.workflowRunId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workflowruns/{workflowRunId}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a workflow run by its run id
      effect: destructive
      questions:
      - Can I cancel a workflow run using just its run id and leave a comment why?
      - How do I stop a workflow run by id rather than by workflow name?
      instructions:
      - text: Cancel workflow run {run_id} with comment {comment}.
        slots:
          run_id: path.workflowRunId
          comment: requestBody.comment
      - text: Stop run id {run_id}.
        slots:
          run_id: path.workflowRunId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List runs of a Standard Logic App workflow
      effect: read
      questions:
      - Which runs has a workflow inside my Standard Logic App site executed?
      - Can I filter the run history of a workflow hosted in an App Service site?
      instructions:
      - text: List runs of workflow {workflow} in Standard Logic App site {site}, resource group {rg}, subscription {sub}.
        slots:
          workflow: path.workflowName
          site: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show the top {top} runs of site {site} workflow {workflow}.
        slots:
          top: query.$top
          site: path.name
          workflow: path.workflowName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a run of a Standard Logic App workflow
      effect: read
      questions:
      - What happened in one run of a workflow on my Standard Logic App site?
      - Where do I check a single run hosted on an App Service Logic App?
      instructions:
      - text: Get run {run} of workflow {workflow} on Standard Logic App site {site}, resource group {rg}, subscription {sub}.
        slots:
          run: path.runName
          workflow: path.workflowName
          site: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show site {site} workflow {workflow} run {run}.
        slots:
          site: path.name
          workflow: path.workflowName
          run: path.runName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a run of a Standard Logic App workflow
      effect: destructive
      questions:
      - How do I cancel a stuck run on a Standard Logic App site?
      - Can I abort a workflow run hosted in my App Service Logic App?
      instructions:
      - text: Cancel run {run} of workflow {workflow} on Standard Logic App site {site}, resource group {rg}, subscription {sub}.
        slots:
          run: path.runName
          workflow: path.workflowName
          site: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Abort site {site} workflow {workflow} run {run}.
        slots:
          site: path.name
          workflow: path.workflowName
          run: path.runName
      method: generated
      generated: '2026-10-01'