Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/confluent-the-data-streaming-platform-organizations-org-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 4

$.info
$.paths['/org/v2/organizations'].get
$.paths['/org/v2/organizations/{id}'].get
$.paths['/org/v2/organizations/{id}'].patch

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 (org/v2) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-organizations-org-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: 3
- target: $.paths['/org/v2/organizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List organizations
      effect: read
      questions:
      - Which Confluent Cloud organizations can I access?
      - Can I page through all organizations on my account?
      instructions:
      - text: List my organizations.
      - text: Show every organization I belong to.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/org/v2/organizations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization
      effect: read
      questions:
      - Is just-in-time user provisioning turned on for my organization?
      - Can I read an organization's details by ID?
      instructions:
      - text: Get organization {id}.
        slots:
          id: path.id
      - text: Show the settings of organization {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/org/v2/organizations/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an organization
      effect: write
      questions:
      - How do I rename my organization?
      - Can I enable just-in-time provisioning for SSO users?
      instructions:
      - text: Rename organization {id} to {display_name}.
        slots:
          id: path.id
          display_name: requestBody.display_name
      - text: Set just-in-time provisioning on organization {id} to {jit_enabled}.
        slots:
          id: path.id
          jit_enabled: requestBody.jit_enabled
      method: generated
      generated: '2026-09-26'