Buildkite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Buildkite REST Agent Tokens API

2 actions 2 updates phrasing extends openapi/buildkite-com-agent-tokens-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}/clusters/{cluster}/tokens'].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 Agent Tokens API
  version: 1.0.0
extends: openapi/buildkite-com-agent-tokens-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}/clusters/{cluster}/tokens'].get
  update:
    x-apievangelist-phrasing:
      intent: List agent tokens for a cluster
      effect: read
      questions:
      - Which agent registration tokens exist for one of my clusters?
      - Where can I see the tokens agents use to join a particular cluster?
      instructions:
      - text: List the agent tokens for cluster {cluster} in organization {org}.
        slots:
          org: path.org
          cluster: path.cluster
      - text: Show every agent registration token attached to cluster {cluster}.
        slots:
          cluster: path.cluster
      method: generated
      generated: '2026-10-01'