Buildkite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Buildkite REST Jobs API

3 actions 3 updates phrasing extends openapi/buildkite-com-jobs-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 3

$.info

$.paths['/organizations/{org}/pipelines/{pipeline}/builds/{number}/jobs/{job}/retry'].put

$.paths['/organizations/{org}/pipelines/{pipeline}/builds/{number}/jobs/{job}/log'].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 Jobs API
  version: 1.0.0
extends: openapi/buildkite-com-jobs-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: 2
- target: $.paths['/organizations/{org}/pipelines/{pipeline}/builds/{number}/jobs/{job}/retry'].put
  update:
    x-apievangelist-phrasing:
      intent: Retry a job in a build
      effect: write
      questions:
      - How do I retry a single failed job without rebuilding everything?
      - Can I re-run just one step of a build?
      instructions:
      - text: Retry job {job} in build {number} of pipeline {pipeline} in {org}.
        slots:
          org: path.org
          pipeline: path.pipeline
          number: path.number
          job: path.job
      - text: Re-run the failed job {job} from build {number}.
        slots:
          job: path.job
          number: path.number
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{org}/pipelines/{pipeline}/builds/{number}/jobs/{job}/log'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a job's log output
      effect: read
      questions:
      - How do I download the log output of a job?
      - Where can I read the console output a build step printed?
      instructions:
      - text: Get the log for job {job} in build {number} of pipeline {pipeline} in {org}.
        slots:
          org: path.org
          pipeline: path.pipeline
          number: path.number
          job: path.job
      - text: Show me the console output of job {job}.
        slots:
          job: path.job
      method: generated
      generated: '2026-10-01'