Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/confluent-the-data-streaming-platform-service-accounts-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 6

$.info

$.paths['/iam/v2/service-accounts'].get

$.paths['/iam/v2/service-accounts'].post

$.paths['/iam/v2/service-accounts/{id}'].get

$.paths['/iam/v2/service-accounts/{id}'].delete

$.paths['/iam/v2/service-accounts/{id}'].patch

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 Service Accounts (iam/v2) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-service-accounts-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: 5
- target: $.paths['/iam/v2/service-accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List service accounts
      effect: read
      questions:
      - Which service accounts exist in my organization?
      - Can I find service accounts by display name?
      instructions:
      - text: List all service accounts.
      - text: Find service accounts named {name}.
        slots:
          name: query.display_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/service-accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a service account
      effect: write
      questions:
      - How do I create a service account for an application?
      - Can I give a service account a description when I create it?
      instructions:
      - text: Create service account {name}.
        slots:
          name: requestBody.display_name
      - text: Create service account {name} described as {description}.
        slots:
          name: requestBody.display_name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/service-accounts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a service account
      effect: read
      questions:
      - What are the details of a given service account?
      - Can I look up a service account by ID?
      instructions:
      - text: Get service account {id}.
        slots:
          id: path.id
      - text: Show service account {id}'s name and description.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/service-accounts/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a service account
      effect: destructive
      questions:
      - Does deleting a service account also remove its API keys?
      - Can I remove a service account an app no longer uses?
      instructions:
      - text: Delete service account {id}.
        slots:
          id: path.id
      - text: Remove service account {id} and everything it owns.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/service-accounts/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a service account
      effect: write
      questions:
      - Can I change a service account's description?
      - Is it possible to edit the description of an existing app identity?
      instructions:
      - text: Update the description of service account {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      - text: Change the description on {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'