CloudBees · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloudbees Users API

4 actions 4 updates phrasing extends openapi/cloudbees-users-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/users'].get

$.paths['/v3/organizations/{organizationId}/invite'].post

$.paths['/v3/organizations/{organizationId}/user/{userId}'].delete

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 Users API
  version: 1.0.0
extends: openapi/cloudbees-users-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/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users
      effect: read
      questions:
      - Which users can I see in CloudBees?
      - Can I find a user by their email address?
      - How many users are returned per page at most?
      instructions:
      - text: List the users I have access to.
      - text: Find the user with email {email}.
        slots:
          email: query.email
      - text: List users in tenant {tenantId} sorted by {orderBy}.
        slots:
          tenantId: query.tenantId
          orderBy: query.orderBy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/organizations/{organizationId}/invite'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite users to an organization
      effect: write
      questions:
      - How do I invite new people to my organization by email?
      - Can I invite users straight into specific teams?
      - How long do organization invitations last before they expire?
      instructions:
      - text: Invite {emails} to organization {organizationId}.
        slots:
          emails: requestBody.emails
          organizationId: path.organizationId
      - text: Invite {emails} to org {organizationId} and add them to teams {teamIds}.
        slots:
          emails: requestBody.emails
          organizationId: path.organizationId
          teamIds: requestBody.teamIds
      - text: Send invites to {emails} for org {organizationId} that expire at {expirationDate}.
        slots:
          emails: requestBody.emails
          organizationId: path.organizationId
          expirationDate: requestBody.expirationDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/organizations/{organizationId}/user/{userId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from an organization
      effect: destructive
      questions:
      - How do I revoke someone's access to my whole organization?
      - Does removing a user from an organization take them off all its teams?
      instructions:
      - text: Remove user {userId} from organization {organizationId}.
        slots:
          userId: path.userId
          organizationId: path.organizationId
      - text: Revoke all access for user {userId} across every team in organization {organizationId}.
        slots:
          userId: path.userId
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'