CloudBees · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for CloudBees CI REST API (Jenkins-compatible) Queue API

2 actions 2 updates phrasing extends openapi/cloudbees-queue-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for CloudBees's API. It is a proposal applied on top of the contract, not a document CloudBees publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/queue/api/json'].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 CloudBees CI REST API (Jenkins-compatible) Queue API
  version: 1.0.0
extends: openapi/cloudbees-queue-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['/queue/api/json'].get
  update:
    x-apievangelist-phrasing:
      intent: Show the pending build queue
      effect: read
      questions:
      - Which builds are waiting in the queue on my CloudBees CI controller?
      - Why is my build stuck waiting instead of running?
      instructions:
      - text: Show me every item waiting in the build queue.
      - text: List the queued builds, returning only {tree}.
        slots:
          tree: query.tree
      method: generated
      generated: '2026-10-01'