Buildkite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Buildkite REST Access Token API

3 actions 3 updates phrasing extends openapi/buildkite-com-access-token-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['/access-token'].get

$.paths['/access-token'].delete

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 Access Token API
  version: 1.0.0
extends: openapi/buildkite-com-access-token-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['/access-token'].get
  update:
    x-apievangelist-phrasing:
      intent: Inspect the API access token in use
      effect: read
      questions:
      - Which scopes does the Buildkite API token I'm using right now have?
      - Can I check what my current access token is allowed to do before calling other endpoints?
      instructions:
      - text: Show me the details and scopes of the access token I'm calling with.
      - text: Check which permissions my current API token grants.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/access-token'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke the API access token in use
      effect: destructive
      questions:
      - How do I revoke the access token I'm currently authenticating with?
      - Can a leaked API token kill itself through the API without logging into the dashboard?
      instructions:
      - text: Revoke the access token I'm using for this session.
      - text: Permanently invalidate my current API token so it can't be used again.
      method: generated
      generated: '2026-10-01'