Azure DevOps · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Azure DevOps Test Plans Test Cases API

3 actions 3 updates phrasing extends openapi/microsoft-azure-devops-test-cases-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Azure DevOps's API. It is a proposal applied on top of the contract, not a document Azure DevOps publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/testplan/plans/{planId}/suites/{suiteId}/testcases'].get
$.paths['/testplan/plans/{planId}/suites/{suiteId}/testcases'].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 Azure DevOps Test Plans Test Cases API
  version: 1.0.0
extends: openapi/microsoft-azure-devops-test-cases-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: 2
- target: $.paths['/testplan/plans/{planId}/suites/{suiteId}/testcases'].get
  update:
    x-apievangelist-phrasing:
      intent: List test cases in a test suite
      effect: read
      questions:
      - Which test cases belong to a given test suite?
      - Can I include test cases from child suites too?
      instructions:
      - text: List the test cases in suite {suiteId} of test plan {planId}.
        slots:
          suiteId: path.suiteId
          planId: path.planId
      - text: List test cases in suite {suiteId} of plan {planId} for configurations {configurationIds}.
        slots:
          suiteId: path.suiteId
          planId: path.planId
          configurationIds: query.configurationIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/testplan/plans/{planId}/suites/{suiteId}/testcases'].post
  update:
    x-apievangelist-phrasing:
      intent: Add existing test cases to a suite
      effect: write
      questions:
      - How do I put existing Test Case work items into a test suite?
      - Can I add a test case to a suite if it is not yet a Test Case work item?
      instructions:
      - text: Add test cases to suite {suiteId} in test plan {planId}.
        slots:
          suiteId: path.suiteId
          planId: path.planId
      - text: Put existing Test Case work items into suite {suiteId} of plan {planId}.
        slots:
          suiteId: path.suiteId
          planId: path.planId
      method: generated
      generated: '2026-09-26'