CloudBees · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloudbees Teams API

4 actions 4 updates phrasing extends openapi/cloudbees-teams-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 4

$.info
$.paths['/v4/teams'].get
$.paths['/v4/teams/{id}'].get
$.paths['/v1/organizations/{organizationId}/teams'].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 Teams API
  version: 1.0.0
extends: openapi/cloudbees-teams-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: 3
- target: $.paths['/v4/teams'].get
  update:
    x-apievangelist-phrasing:
      intent: List teams
      effect: read
      questions:
      - Which teams exist in my CloudBees tenant?
      - Can I list teams along with their members inline?
      - Is there a way to find a team by its name?
      instructions:
      - text: List all my teams.
      - text: Find teams named {name}.
        slots:
          name: query.name
      - text: List teams sorted by {orderBy}, including {include}.
        slots:
          orderBy: query.orderBy
          include: query.include
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v4/teams/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a team
      effect: read
      questions:
      - How do I see the details of one team?
      - Can I get a team together with its users?
      instructions:
      - text: Get team {id}.
        slots:
          id: path.id
      - text: Show team {id} including {include}.
        slots:
          id: path.id
          include: query.include
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/teams'].get
  update:
    x-apievangelist-phrasing:
      intent: List teams in an organization
      effect: read
      questions:
      - Which teams belong to a specific organization?
      - What teams in an organization is a given user part of?
      instructions:
      - text: List the teams in organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: List teams in organization {organizationId} that include user {userId}.
        slots:
          organizationId: path.organizationId
          userId: query.userId
      method: generated
      generated: '2026-09-26'