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.
# 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 Suites API
version: 1.0.0
extends: openapi/microsoft-azure-devops-test-suites-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: 3
- target: $.paths['/testplan/plans/{planId}/suites'].get
update:
x-apievangelist-phrasing:
intent: List test suites in a test plan
effect: read
questions:
- What test suites are in a test plan?
- Can I get a plan's suites as a tree?
instructions:
- text: List the test suites in plan {planId}.
slots:
planId: path.planId
- text: Show the suites of test plan {planId} as a tree view.
slots:
planId: path.planId
method: generated
generated: '2026-09-26'
- target: $.paths['/testplan/plans/{planId}/suites'].post
update:
x-apievangelist-phrasing:
intent: Create a test suite
effect: write
questions:
- How do I add a requirement-based suite to a test plan?
- Can I create a query-based suite that pulls test cases automatically?
instructions:
- text: Create a {suiteType} suite named {name} under parent {parentSuite} in plan {planId}.
slots:
suiteType: requestBody.suiteType
name: requestBody.name
parentSuite: requestBody.parentSuite
planId: path.planId
- text: Create a requirement-based suite {name} for requirement {requirementId} under {parentSuite} in plan {planId} of type {suiteType}.
slots:
name: requestBody.name
requirementId: requestBody.requirementId
parentSuite: requestBody.parentSuite
planId: path.planId
suiteType: requestBody.suiteType
method: generated
generated: '2026-09-26'
- target: $.paths['/testplan/plans/{planId}/suites/{suiteId}'].get
update:
x-apievangelist-phrasing:
intent: Get a test suite
effect: read
questions:
- What type is a test suite and which suite is its parent?
- Can I view the details of one suite in a plan?
instructions:
- text: Show test suite {suiteId} in plan {planId}.
slots:
suiteId: path.suiteId
planId: path.planId
- text: Get the type and parent of suite {suiteId} in test plan {planId}.
slots:
suiteId: path.suiteId
planId: path.planId
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.