Confluent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Kafka REST ACLs API

3 actions 3 updates phrasing extends openapi/confluent-acls-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 3

$.info

$.paths['/kafka/v3/clusters/{cluster_id}/acls'].get

$.paths['/kafka/v3/clusters/{cluster_id}/acls'].post

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 Kafka REST ACLs API
  version: 1.0.0
extends: openapi/confluent-acls-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['/kafka/v3/clusters/{cluster_id}/acls'].get
  update:
    x-apievangelist-phrasing:
      intent: List ACLs on a Kafka cluster
      effect: read
      questions:
      - Which access control rules are set on my Kafka cluster?
      - How do I see who has permission to read or write topics?
      instructions:
      - text: List ACLs on cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
      - text: Show all access control rules for Kafka cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/acls'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an ACL on a Kafka cluster
      effect: write
      questions:
      - Can I grant a service account permission to read a topic?
      - What does a prefixed pattern type do when creating an ACL?
      instructions:
      - text: Allow {principal} to {operation} on {resource_type} {resource_name} in cluster {cluster_id}.
        slots:
          principal: requestBody.principal
          operation: requestBody.operation
          resource_type: requestBody.resource_type
          resource_name: requestBody.resource_name
          cluster_id: path.cluster_id
      - text: Create a {permission} ACL for {principal} on {resource_name} with pattern {pattern_type} in {cluster_id}.
        slots:
          permission: requestBody.permission
          principal: requestBody.principal
          resource_name: requestBody.resource_name
          pattern_type: requestBody.pattern_type
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'