Buildkite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Buildkite REST Rules API

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

OpenAPI Overlay

Raw ↑ 
# 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 Rules API
  version: 1.0.0
extends: openapi/buildkite-com-rules-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}/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's rules
      effect: read
      questions:
      - What rules are set up in my organization?
      - Can I see which cross-pipeline rules my org enforces?
      instructions:
      - text: List the rules for organization {org}.
        slots:
          org: path.org
      - text: Show every rule configured in {org}.
        slots:
          org: path.org
      method: generated
      generated: '2026-10-01'