CloudBees · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for CloudBees Unify API (Current) Environments API

2 actions 2 updates phrasing extends openapi/cloudbees-environments-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['/v2/organizations/{orgId}/environments'].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 Unify API (Current) Environments API
  version: 1.0.0
extends: openapi/cloudbees-environments-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/v2/organizations/{orgId}/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List environments in an organization
      effect: read
      questions:
      - Which environments exist in my CloudBees organization?
      - Can I look up an environment by its name?
      - How do I get environment timestamps in my own time zone?
      instructions:
      - text: List the environments in organization {orgId}.
        slots:
          orgId: path.orgId
      - text: Find the environment named {name} in org {orgId}.
        slots:
          name: query.name
          orgId: path.orgId
      - text: List environments in org {orgId} with times shown in {timeZone}.
        slots:
          orgId: path.orgId
          timeZone: query.timeZone
      method: generated
      generated: '2026-09-26'