Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Invitations (iam/v2) API

5 actions 5 updates phrasing extends openapi/confluent-the-data-streaming-platform-invitations-iam-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 5

$.info

$.paths['/iam/v2/invitations'].get

$.paths['/iam/v2/invitations'].post

$.paths['/iam/v2/invitations/{id}'].get

$.paths['/iam/v2/invitations/{id}'].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 Confluent Cloud Invitations (iam/v2) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-invitations-iam-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: 4
- target: $.paths['/iam/v2/invitations'].get
  update:
    x-apievangelist-phrasing:
      intent: List user invitations
      effect: read
      questions:
      - Which user invitations to my organization are still pending?
      - Can I find the invitation sent to a particular email address?
      instructions:
      - text: List invitations with status {status}.
        slots:
          status: query.status
      - text: Find the invitation sent to {email}.
        slots:
          email: query.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/invitations'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite a user to the organization
      effect: write
      questions:
      - How do I invite a new user to my Confluent Cloud organization?
      - Does an invited user get any permissions automatically?
      instructions:
      - text: Invite {email} to the organization.
        slots:
          email: requestBody.email
      - text: Send an invitation to {email} using auth type {auth_type}.
        slots:
          email: requestBody.email
          auth_type: requestBody.auth_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/invitations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an invitation
      effect: read
      questions:
      - Has a specific invitation been accepted or has it expired?
      - Can I see who created one invitation?
      instructions:
      - text: Show invitation {id}.
        slots:
          id: path.id
      - text: Check the status of invitation {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/invitations/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke an invitation
      effect: destructive
      questions:
      - How do I cancel an invitation I sent by mistake?
      - What happens to the user if I delete an invitation they never accepted?
      instructions:
      - text: Delete invitation {id}.
        slots:
          id: path.id
      - text: Revoke pending invitation {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'