CloudBees · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for CloudBees Unify API (Beta) Team Memberships API

5 actions 5 updates phrasing extends openapi/cloudbees-team-memberships-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 5

$.info

$.paths['/v4/teams/{teamId}/memberships'].get

$.paths['/v4/teams/{teamId}/memberships'].post

$.paths['/v4/teams/{teamId}/memberships/{userId}'].get

$.paths['/v4/teams/{teamId}/memberships/{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 Unify API (Beta) Team Memberships API
  version: 1.0.0
extends: openapi/cloudbees-team-memberships-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: 4
- target: $.paths['/v4/teams/{teamId}/memberships'].get
  update:
    x-apievangelist-phrasing:
      intent: List members of a team
      effect: read
      questions:
      - Who are the members of a team?
      - How many team members can I get back per page?
      instructions:
      - text: List the memberships of team {teamId}.
        slots:
          teamId: path.teamId
      - text: Show the next page of members of team {teamId} using token {pageToken}.
        slots:
          teamId: path.teamId
          pageToken: query.pageToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v4/teams/{teamId}/memberships'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a user to a team
      effect: write
      questions:
      - How do I add a user to a team?
      - Can I give an existing user membership in another team?
      instructions:
      - text: Add user {userId} to team {teamId}.
        slots:
          userId: requestBody.userId
          teamId: path.teamId
      - text: Make user {userId} a member of team {teamId}.
        slots:
          userId: requestBody.userId
          teamId: path.teamId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v4/teams/{teamId}/memberships/{userId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a user's membership in a team
      effect: read
      questions:
      - Is a particular user a member of a given team?
      - What details are stored about a user's team membership?
      instructions:
      - text: Get the membership of user {userId} in team {teamId}.
        slots:
          userId: path.userId
          teamId: path.teamId
      - text: Check whether user {userId} belongs to team {teamId}.
        slots:
          userId: path.userId
          teamId: path.teamId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v4/teams/{teamId}/memberships/{userId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from a team
      effect: destructive
      questions:
      - How do I remove someone from a single team?
      - Can I take a user off one team without affecting their other teams?
      instructions:
      - text: Remove user {userId} from team {teamId}.
        slots:
          userId: path.userId
          teamId: path.teamId
      - text: Delete the team membership of user {userId} in team {teamId}.
        slots:
          userId: path.userId
          teamId: path.teamId
      method: generated
      generated: '2026-09-26'