CloudBees · OpenAPI Overlay 1.0.0

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

2 actions 2 updates phrasing extends openapi/cloudbees-python-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['/api/python'].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) Python API
  version: 1.0.0
extends: openapi/cloudbees-python-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['/api/python'].get
  update:
    x-apievangelist-phrasing:
      intent: Get controller metadata as a Python literal
      effect: read
      questions:
      - Can I get my controller's metadata in a form Python can eval directly?
      - Is there a Python-literal version of the CloudBees CI root API?
      instructions:
      - text: Fetch the controller's top-level metadata as a Python literal.
      - text: Get the controller metadata in Python format, limited to {tree} at depth {depth}.
        slots:
          tree: query.tree
          depth: query.depth
      method: generated
      generated: '2026-10-01'