Azure DevOps · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Azure DevOps Service Hooks Notifications API

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

$.info

$.paths['/hooks/testnotifications'].post

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 Notifications API
  version: 1.0.0
extends: openapi/microsoft-azure-devops-notifications-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: 1
- target: $.paths['/hooks/testnotifications'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test service hook notification
      effect: write
      questions:
      - How can I check that a service hook reaches its endpoint before relying on it?
      - Can a test notification use real event data instead of sample data?
      instructions:
      - text: Test {eventType} from {publisherId} to {consumerId} action {consumerActionId} with inputs {publisherInputs} and {consumerInputs}.
        slots:
          eventType: requestBody.eventType
          publisherId: requestBody.publisherId
          consumerId: requestBody.consumerId
          consumerActionId: requestBody.consumerActionId
          publisherInputs: requestBody.publisherInputs
          consumerInputs: requestBody.consumerInputs
      - text: Fire a test {eventType} event to consumer {consumerId} to verify the hook.
        slots:
          eventType: requestBody.eventType
          consumerId: requestBody.consumerId
      method: generated
      generated: '2026-09-26'