Azure DevOps · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Azure Devops Pipelines API

7 actions 7 updates phrasing extends openapi/microsoft-azure-devops-pipelines-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 7

$.info
$.paths['/pipelines'].get
$.paths['/pipelines'].post
$.paths['/pipelines/{pipelineId}'].get
$.paths['/{project}/_apis/pipelines'].get
$.paths['/{project}/_apis/pipelines'].post
$.paths['/{project}/_apis/pipelines/{pipelineId}'].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 Microsoft Azure Devops Pipelines API
  version: 1.0.0
extends: openapi/microsoft-azure-devops-pipelines-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: 6
- target: $.paths['/pipelines'].get
  update:
    x-apievangelist-phrasing:
      intent: List pipelines
      effect: read
      questions:
      - What YAML pipelines are defined in my Azure DevOps project?
      - Can I sort the pipeline list and page through it with a continuation token?
      instructions:
      - text: List my pipelines.
      - text: List pipelines ordered by {orderBy}.
        slots:
          orderBy: query.orderBy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipelines'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a pipeline from a YAML file
      effect: write
      questions:
      - How do I register a YAML file in my repo as a new pipeline?
      - Can I put a new pipeline into a folder when creating it?
      instructions:
      - text: Create a pipeline named {name} using configuration {configuration}.
        slots:
          name: requestBody.name
          configuration: requestBody.configuration
      - text: Create pipeline {name} in folder {folder} from YAML configuration {configuration}.
        slots:
          name: requestBody.name
          folder: requestBody.folder
          configuration: requestBody.configuration
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipelines/{pipelineId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pipeline
      effect: read
      questions:
      - Which repository and YAML file does a pipeline point to?
      - Can I look at a specific revision of a pipeline?
      instructions:
      - text: Show pipeline {pipelineId}.
        slots:
          pipelineId: path.pipelineId
      - text: Get version {pipelineVersion} of pipeline {pipelineId}.
        slots:
          pipelineVersion: query.pipelineVersion
          pipelineId: path.pipelineId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{project}/_apis/pipelines'].get
  update:
    x-apievangelist-phrasing:
      intent: List pipelines in a named project
      effect: read
      questions:
      - Which pipelines exist in one named project of an organization?
      - Can I list a specific project's pipelines by putting the organization and project in the URL?
      instructions:
      - text: List pipelines in project {project} of organization {organization}.
        slots:
          project: path.project
          organization: path.organization
      - text: List the first {top} pipelines in project {project}.
        slots:
          top: query.$top
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{project}/_apis/pipelines'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a pipeline in a named project
      effect: write
      questions:
      - How do I add a YAML pipeline to a specific project in a given organization?
      - Can I create a pipeline in another project by naming that project explicitly?
      instructions:
      - text: Create pipeline {name} in project {project} of organization {organization} from configuration {configuration}.
        slots:
          name: requestBody.name
          project: path.project
          organization: path.organization
          configuration: requestBody.configuration
      - text: Add pipeline {name} under folder {folder} in project {project} using {configuration}.
        slots:
          name: requestBody.name
          folder: requestBody.folder
          project: path.project
          configuration: requestBody.configuration
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{project}/_apis/pipelines/{pipelineId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pipeline in a named project
      effect: read
      questions:
      - Where do I look up one pipeline when I know its organization, project and ID?
      - Can I fetch a pipeline from a project other than my default one?
      instructions:
      - text: Get pipeline {pipelineId} in project {project} of organization {organization}.
        slots:
          pipelineId: path.pipelineId
          project: path.project
          organization: path.organization
      - text: Show pipeline {pipelineId} from project {project}.
        slots:
          pipelineId: path.pipelineId
          project: path.project
      method: generated
      generated: '2026-09-26'