Confluent · 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-service-accounts-iam-v2-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Confluent's API. It is a proposal applied on top of the contract, not a document Confluent 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-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 Confluent Cloud organization?
      - Can I find a service account by its display name?
      instructions:
      - text: List all service accounts.
      - text: List service accounts named {display_name}.
        slots:
          display_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 to authenticate with?
      - Can I give a new service account a description?
      instructions:
      - text: Create service account {display_name}.
        slots:
          display_name: requestBody.display_name
      - text: Create service account {display_name} described as {description}.
        slots:
          display_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: Get one service account
      effect: read
      questions:
      - What is the name and description of a given service account?
      - How do I look up a service account by ID?
      instructions:
      - text: Get service account {id}.
        slots:
          id: path.id
      - text: Show details of service account {id}.
        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:
      - How do I delete a service account an application no longer uses?
      - What happens to a service account's API keys when it is deleted?
      instructions:
      - text: Delete service account {id}.
        slots:
          id: path.id
      - text: Remove service account {id} from the organization.
        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's description
      effect: write
      questions:
      - Can I change the description of an existing service account?
      - Is it possible to edit a service account after creating it?
      instructions:
      - text: Update service account {id} description to {description}.
        slots:
          id: path.id
          description: requestBody.description
      - text: Set the description of service account {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'