Buildkite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Buildkite REST Organizations API

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

$.paths['/organizations/{org}'].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 Organizations API
  version: 1.0.0
extends: openapi/buildkite-com-organizations-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'].get
  update:
    x-apievangelist-phrasing:
      intent: List organizations I belong to
      effect: read
      questions:
      - Which Buildkite organizations can my token access?
      - How do I find my organization slugs?
      instructions:
      - text: List the organizations I have access to.
      - text: Show every org my API token can see.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{org}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one organization
      effect: read
      questions:
      - Can I fetch the details of a single organization by its slug?
      - What does the API return about a specific organization?
      instructions:
      - text: Get organization {org}.
        slots:
          org: path.org
      - text: Show me the details for the {org} organization.
        slots:
          org: path.org
      method: generated
      generated: '2026-10-01'