Buildkite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Buildkite REST Annotations API

2 actions 2 updates phrasing extends openapi/buildkite-com-annotations-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Buildkite's API. It is a proposal applied on top of the contract, not a document Buildkite publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/organizations/{org}/pipelines/{pipeline}/builds/{number}/annotations'].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 Buildkite REST Annotations API
  version: 1.0.0
extends: openapi/buildkite-com-annotations-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/organizations/{org}/pipelines/{pipeline}/builds/{number}/annotations'].get
  update:
    x-apievangelist-phrasing:
      intent: List annotations on a build
      effect: read
      questions:
      - How do I read the annotations steps added to a build?
      - Where can I fetch the test summaries and notes annotated onto a build page?
      instructions:
      - text: List annotations for build {number} of pipeline {pipeline} in {org}.
        slots:
          org: path.org
          pipeline: path.pipeline
          number: path.number
      - text: Show the annotations posted on build {number} of {pipeline}.
        slots:
          number: path.number
          pipeline: path.pipeline
      method: generated
      generated: '2026-10-01'