# 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 Pipelines API
  version: 1.0.0
extends: openapi/buildkite-com-pipelines-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: 5
- target: $.paths['/organizations/{org}/pipelines'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's pipelines
      effect: read
      questions:
      - What pipelines exist in my organization?
      - How do I get every pipeline slug for my org?
      instructions:
      - text: List pipelines in organization {org}.
        slots:
          org: path.org
      - text: Show me all the pipelines configured for {org}.
        slots:
          org: path.org
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{org}/pipelines'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new pipeline
      effect: write
      questions:
      - How do I create a pipeline for a repository through the API?
      - Can I set the default branch and cluster when creating a pipeline?
      instructions:
      - text: Create a pipeline named {name} for repository {repository} in {org}.
        slots:
          name: requestBody.name
          repository: requestBody.repository
          org: path.org
      - text: Create pipeline {name} in {org} on cluster {cluster_id} with default branch {default_branch}.
        slots:
          name: requestBody.name
          org: path.org
          cluster_id: requestBody.cluster_id
          default_branch: requestBody.default_branch
      - text: 'Set up a new pipeline {name} in {org} with these steps: {configuration}.'
        slots:
          name: requestBody.name
          org: path.org
          configuration: requestBody.configuration
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{org}/pipelines/{pipeline}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one pipeline's settings
      effect: read
      questions:
      - Can I see the repository and default branch a specific pipeline uses?
      - How do I fetch the configuration of a single pipeline?
      instructions:
      - text: Get pipeline {pipeline} in organization {org}.
        slots:
          org: path.org
          pipeline: path.pipeline
      - text: Show me the settings of the {pipeline} pipeline.
        slots:
          pipeline: path.pipeline
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{org}/pipelines/{pipeline}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a pipeline
      effect: destructive
      questions:
      - How do I delete a pipeline I no longer need?
      - Is removing a pipeline through the API permanent?
      instructions:
      - text: Delete pipeline {pipeline} from organization {org}.
        slots:
          org: path.org
          pipeline: path.pipeline
      - text: Permanently remove the {pipeline} pipeline.
        slots:
          pipeline: path.pipeline
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{org}/pipelines/{pipeline}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an existing pipeline
      effect: write
      questions:
      - How do I change the settings of a pipeline that already exists?
      - Can I edit an existing pipeline through the API instead of the UI?
      instructions:
      - text: Update pipeline {pipeline} in organization {org}.
        slots:
          org: path.org
          pipeline: path.pipeline
      - text: Change the settings of the existing {pipeline} pipeline.
        slots:
          pipeline: path.pipeline
      method: generated
      generated: '2026-10-01'