# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Azure DevOps Test Plans API
  version: 1.0.0
extends: openapi/microsoft-azure-devops-test-plans-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['/testplan/plans'].get
  update:
    x-apievangelist-phrasing:
      intent: List test plans
      effect: read
      questions:
      - What test plans exist in my Azure DevOps project?
      - Can I list only active test plans or those owned by one person?
      instructions:
      - text: List all test plans in the project.
      - text: List active test plans owned by {owner}.
        slots:
          owner: query.owner
      method: generated
      generated: '2026-09-26'
- target: $.paths['/testplan/plans'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a test plan
      effect: write
      questions:
      - How do I create a test plan for a sprint?
      - Can I set start and end dates and an area path on a new test plan?
      instructions:
      - text: Create a test plan named {name}.
        slots:
          name: requestBody.name
      - text: Create test plan {name} for iteration {iteration} from {startDate} to {endDate}.
        slots:
          name: requestBody.name
          iteration: requestBody.iteration
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/testplan/plans/{planId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a test plan
      effect: read
      questions:
      - Who owns a test plan and what iteration does it cover?
      - What date range and area path is a given test plan set to?
      instructions:
      - text: Show test plan {planId}.
        slots:
          planId: path.planId
      - text: Get the owner and dates of test plan {planId}.
        slots:
          planId: path.planId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/testplan/plans/{planId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a test plan
      effect: destructive
      questions:
      - Does deleting a test plan remove its suites too?
      - Can a deleted test plan be recovered?
      instructions:
      - text: Delete test plan {planId}.
        slots:
          planId: path.planId
      - text: Permanently remove test plan {planId} and its suites.
        slots:
          planId: path.planId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/testplan/plans/{planId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a test plan
      effect: write
      questions:
      - How do I extend the end date of an existing test plan?
      - Can I rename a test plan or change its state?
      instructions:
      - text: Set the end date of test plan {planId} to {endDate}.
        slots:
          planId: path.planId
          endDate: requestBody.endDate
      - text: Rename test plan {planId} to {name}.
        slots:
          planId: path.planId
          name: requestBody.name
      - text: Change the state of test plan {planId} to {status}.
        slots:
          planId: path.planId
          status: requestBody.status
      method: generated
      generated: '2026-09-26'