# 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 API
  version: 1.0.0
extends: openapi/microsoft-azure-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: 12
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/jobs/{workflowName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a job in an Azure Migrate modernize project
      effect: read
      questions:
      - What is the status of a migration job in my modernize project?
      - Can I see the details of one workflow inside an Azure Migrate modernize project?
      instructions:
      - text: Get job {workflow} in modernize project {project} in resource group {resource_group}.
        slots:
          workflow: path.workflowName
          project: path.modernizeProjectName
          resource_group: path.resourceGroupName
      - text: Show modernize-project workflow {workflow} from project {project} under subscription {subscription}.
        slots:
          workflow: path.workflowName
          project: path.modernizeProjectName
          subscription: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List jobs in an Azure Migrate modernize project
      effect: read
      questions:
      - Which migration jobs have run in my modernize project?
      - Can I filter the jobs of a modernize project and continue from a paging token?
      instructions:
      - text: List jobs in modernize project {project} in resource group {resource_group} of subscription {subscription}.
        slots:
          project: path.modernizeProjectName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: List modernize-project jobs in {project} matching {filter}.
        slots:
          project: path.modernizeProjectName
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/jobs/{workflowName}/operations/{operationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Track an async operation on a modernize project job
      effect: read
      questions:
      - Has the asynchronous operation on my modernize project job finished?
      - How do I poll the result of a long-running action on an Azure Migrate modernize workflow?
      instructions:
      - text: Get status of operation {operation_id} on job {workflow} in modernize project {project}, resource group {resource_group}, subscription {subscription}.
        slots:
          operation_id: path.operationId
          workflow: path.workflowName
          project: path.modernizeProjectName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Poll modernize job operation {operation_id} until it completes.
        slots:
          operation_id: path.operationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/jobs/{jobName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a job in a data replication vault
      effect: read
      questions:
      - What are the details of a replication job in my data replication vault?
      - Did a specific job in the replication vault succeed?
      instructions:
      - text: Get job {job} in replication vault {vault}.
        slots:
          job: path.jobName
          vault: path.vaultName
      - text: Show the replication-vault job {job} from vault {vault} and its outcome.
        slots:
          job: path.jobName
          vault: path.vaultName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List jobs in a data replication vault
      effect: read
      questions:
      - Which jobs have run in my data replication vault?
      - Can I filter replication vault jobs, for example to failed ones only?
      instructions:
      - text: List jobs in replication vault {vault}.
        slots:
          vault: path.vaultName
      - text: List replication vault {vault} jobs matching {filter}.
        slots:
          vault: path.vaultName
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/jobs/{jobName}/operations/{operationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Track an async operation on a replication vault job
      effect: read
      questions:
      - Has the long-running operation on my replication vault job completed?
      - How can I poll an asynchronous action on a data replication job?
      instructions:
      - text: Get the status of operation {operationId} for job {job} in replication vault {vault}.
        slots:
          operationId: path.operationId
          job: path.jobName
          vault: path.vaultName
      - text: Check whether the async operation on vault {vault} job {job} is done.
        slots:
          vault: path.vaultName
          job: path.jobName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.DevHub/workflows'].get
  update:
    x-apievangelist-phrasing:
      intent: List Developer Hub workflows in a subscription
      effect: read
      questions:
      - Which Developer Hub deployment workflows exist across my whole subscription?
      - Can I see every DevHub workflow I have set up, regardless of resource group?
      instructions:
      - text: List all Developer Hub workflows in my subscription.
      - text: Show every DevHub workflow across the subscription.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevHub/workflows'].get
  update:
    x-apievangelist-phrasing:
      intent: List Developer Hub workflows in a resource group
      effect: read
      questions:
      - Which Developer Hub workflows are in one resource group?
      - Can I narrow DevHub workflows to those deploying to a particular AKS cluster?
      instructions:
      - text: List Developer Hub workflows in this resource group.
      - text: List DevHub workflows in the resource group that target managed cluster {cluster}.
        slots:
          cluster: query.managedClusterResource
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevHub/workflows/{workflowName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Developer Hub workflow
      effect: read
      questions:
      - How is a particular Developer Hub workflow configured?
      - Can I look up one DevHub workflow by name?
      instructions:
      - text: Get Developer Hub workflow {workflow}.
        slots:
          workflow: path.workflowName
      - text: Show the configuration of DevHub workflow {workflow}.
        slots:
          workflow: path.workflowName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevHub/workflows/{workflowName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a Developer Hub workflow
      effect: write
      questions:
      - How do I set up a new Developer Hub workflow to deploy my app?
      - Can I change the properties of an existing DevHub workflow in place?
      instructions:
      - text: Create Developer Hub workflow {workflow}.
        slots:
          workflow: path.workflowName
      - text: Create or update DevHub workflow {workflow} with properties {properties}.
        slots:
          workflow: path.workflowName
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevHub/workflows/{workflowName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Developer Hub workflow
      effect: destructive
      questions:
      - How do I remove a Developer Hub workflow I no longer use?
      - Can I delete a DevHub workflow by name?
      instructions:
      - text: Delete Developer Hub workflow {workflow}.
        slots:
          workflow: path.workflowName
      - text: Remove the DevHub workflow named {workflow}.
        slots:
          workflow: path.workflowName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevHub/workflows/{workflowName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update tags on a Developer Hub workflow
      effect: write
      questions:
      - How do I change the tags on a Developer Hub workflow without touching its config?
      - Can I tag a DevHub workflow with a cost center?
      instructions:
      - text: Set tags {tags} on Developer Hub workflow {workflow}.
        slots:
          tags: requestBody.tags
          workflow: path.workflowName
      - text: Replace the tags of DevHub workflow {workflow} with {tags}.
        slots:
          workflow: path.workflowName
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'