CloudBees · OpenAPI Overlay 1.0.0

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

2 actions 2 updates phrasing extends openapi/cloudbees-computer-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['/computer/api/json'].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 CloudBees CI REST API (Jenkins-compatible) Computer API
  version: 1.0.0
extends: openapi/cloudbees-computer-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['/computer/api/json'].get
  update:
    x-apievangelist-phrasing:
      intent: List the build nodes and agents on a controller
      effect: read
      questions:
      - Which build agents are connected to my CloudBees CI controller?
      - Can I see whether any of my Jenkins nodes are offline or idle?
      - What executors does each agent machine have available right now?
      instructions:
      - text: List every node and agent attached to the controller.
      - text: Show the agents on the controller, returning only the fields in {tree}.
        slots:
          tree: query.tree
      - text: List the controller's computers with detail depth {depth}.
        slots:
          depth: query.depth
      method: generated
      generated: '2026-10-01'