# 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 HelpRP Troubleshooter API
  version: 1.0.0
extends: openapi/microsoft-azure-troubleshooter-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the results of a troubleshooter run
      effect: read
      questions:
      - How do I see which steps of an Azure troubleshooter have completed and their results?
      - What status is my running troubleshooter instance in?
      instructions:
      - text: Get troubleshooter {troubleshooter} results at scope {scope}.
        slots:
          troubleshooter: path.troubleshooterName
          scope: path.scope
      - text: Show the step status of troubleshooter {troubleshooter}.
        slots:
          troubleshooter: path.troubleshooterName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Start a troubleshooter for a resource
      effect: write
      questions:
      - How do I launch a guided troubleshooter for a problem on one of my Azure resources?
      - Can I start a troubleshooter at subscription scope using a solution ID?
      instructions:
      - text: Create troubleshooter {troubleshooter} at scope {scope}.
        slots:
          troubleshooter: path.troubleshooterName
          scope: path.scope
      - text: Start troubleshooter {troubleshooter} on {scope} with {properties}.
        slots:
          troubleshooter: path.troubleshooterName
          scope: path.scope
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}/continue'].post
  update:
    x-apievangelist-phrasing:
      intent: Answer a step to continue a troubleshooter
      effect: write
      questions:
      - My troubleshooter is waiting for input; how do I answer and move to the next step?
      - Can I send responses for a specific step ID of a troubleshooter?
      instructions:
      - text: Continue troubleshooter {troubleshooter} at scope {scope} from step {step}.
        slots:
          troubleshooter: path.troubleshooterName
          scope: path.scope
          step: requestBody.stepId
      - text: Submit responses {responses} to troubleshooter {troubleshooter}.
        slots:
          responses: requestBody.responses
          troubleshooter: path.troubleshooterName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}/end'].post
  update:
    x-apievangelist-phrasing:
      intent: End a troubleshooter run
      effect: destructive
      questions:
      - How do I stop a troubleshooter that I no longer need?
      - Can I end a troubleshooter action before all steps finish?
      instructions:
      - text: End troubleshooter {troubleshooter} at scope {scope}.
        slots:
          troubleshooter: path.troubleshooterName
          scope: path.scope
      - text: Stop the troubleshooter session {troubleshooter}.
        slots:
          troubleshooter: path.troubleshooterName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}/restart'].post
  update:
    x-apievangelist-phrasing:
      intent: Restart a troubleshooter from the beginning
      effect: write
      questions:
      - Can I restart a troubleshooter, and does it get a new resource name?
      - What happens to the old troubleshooter name after a restart?
      instructions:
      - text: Restart troubleshooter {troubleshooter} at scope {scope}.
        slots:
          troubleshooter: path.troubleshooterName
          scope: path.scope
      - text: Run troubleshooter {troubleshooter} again from step one.
        slots:
          troubleshooter: path.troubleshooterName
      method: generated
      generated: '2026-09-26'