Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Organizations (partner/v2) API

3 actions 3 updates phrasing extends openapi/confluent-the-data-streaming-platform-organizations-partner-v2-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Confluent | the Data Streaming Platform's API. It is a proposal applied on top of the contract, not a document Confluent | the Data Streaming Platform publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/partner/v2/organizations/{id}'].get
$.paths['/partner/v2/organizations'].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 Confluent Cloud Organizations (partner/v2) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-organizations-partner-v2-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['/partner/v2/organizations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a customer organization
      effect: read
      questions:
      - As a partner, can I view details of one customer organization?
      - What does a customer organization record contain?
      instructions:
      - text: Get organization {id}.
        slots:
          id: path.id
      - text: Show customer organization {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/partner/v2/organizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer organizations
      effect: read
      questions:
      - Which customer organizations are under my partner account?
      - Can I page through all my partner-managed organizations?
      instructions:
      - text: List all my customer organizations.
      - text: List partner organizations, {size} per page.
        slots:
          size: query.page_size
      method: generated
      generated: '2026-09-26'