Azure DevOps · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Azure DevOps Service Hooks Publishers API

3 actions 3 updates phrasing extends openapi/microsoft-azure-devops-publishers-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['/hooks/publishers'].get

$.paths['/hooks/publishers/{publisherId}/eventTypes'].get

OpenAPI Overlay

# 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 Service Hooks Publishers API
  version: 1.0.0
extends: openapi/microsoft-azure-devops-publishers-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['/hooks/publishers'].get
  update:
    x-apievangelist-phrasing:
      intent: List service hook publishers
      effect: read
      questions:
      - What event sources can I subscribe to with Azure DevOps service hooks?
      - Which publishers are available for service hook subscriptions?
      instructions:
      - text: List the service hook publishers.
      - text: Show every event source I can subscribe to, using API version {apiVersion}.
        slots:
          apiVersion: query.api-version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hooks/publishers/{publisherId}/eventTypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List a publisher's event types
      effect: read
      questions:
      - What events, like build completed or code pushed, can a publisher send?
      - Which inputs does each event type of a publisher accept for filtering?
      instructions:
      - text: List the event types for publisher {publisherId}.
        slots:
          publisherId: path.publisherId
      - text: Show the events and filter inputs offered by publisher {publisherId}.
        slots:
          publisherId: path.publisherId
      method: generated
      generated: '2026-09-26'