# 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) Organizations API
  version: 1.0.0
extends: openapi/cloudbees-organizations-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: 2
- target: $.paths['/v1/organizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List organizations I can access
      effect: read
      questions:
      - Which CloudBees organizations do I have access to?
      - Can I list sub-organizations nested under their parents?
      - Is there a way to include deleted organizations in the list?
      instructions:
      - text: List the organizations I can access.
      - text: List organizations that user {userId} is a member of.
        slots:
          userId: query.userId
      - text: Search organizations whose name contains {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/name'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization by exact name
      effect: read
      questions:
      - How do I look up an organization by its exact domain name?
      - Can I get an organization along with all its child organizations?
      instructions:
      - text: Get the organization named exactly {name}.
        slots:
          name: query.name
      - text: 'Look up organization {name} with its child organizations nested: {nested}.'
        slots:
          name: query.name
          nested: query.nested
      method: generated
      generated: '2026-09-26'