Azure DevOps · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Azure DevOps Work Items Work Item Types API

4 actions 4 updates phrasing extends openapi/microsoft-azure-devops-work-item-types-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 4

$.info
$.paths['/wit/workitemtypes'].get
$.paths['/wit/workitemtypes/{type}'].get
$.paths['/wit/fields'].get

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 Work Items Work Item Types API
  version: 1.0.0
extends: openapi/microsoft-azure-devops-work-item-types-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['/wit/workitemtypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List work item types
      effect: read
      questions:
      - What work item types, like Bug or Epic, does my project use?
      - Are there custom work item types defined in the project?
      instructions:
      - text: List the work item types in the project.
      - text: Show every work item type available, using API version {apiVersion}.
        slots:
          apiVersion: query.api-version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/wit/workitemtypes/{type}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a work item type's fields and states
      effect: read
      questions:
      - What states and transitions does the Bug type allow?
      - Which fields and rules apply to a given work item type?
      instructions:
      - text: Show work item type {type}.
        slots:
          type: path.type
      - text: Get the states and fields of the {type} work item type.
        slots:
          type: path.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/wit/fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List work item fields
      effect: read
      questions:
      - What custom fields exist for work items?
      - Which System fields can I use in queries?
      instructions:
      - text: List all work item fields.
      - text: Show every system and custom work item field, using API version {apiVersion}.
        slots:
          apiVersion: query.api-version
      method: generated
      generated: '2026-09-26'