Confluent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Client Quotas (kafka-quotas/v1) API

6 actions 6 updates phrasing extends openapi/confluent-client-quotas-kafka-quotas-v1-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['/kafka-quotas/v1/client-quotas'].get

$.paths['/kafka-quotas/v1/client-quotas'].post

$.paths['/kafka-quotas/v1/client-quotas/{id}'].get

$.paths['/kafka-quotas/v1/client-quotas/{id}'].delete

$.paths['/kafka-quotas/v1/client-quotas/{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 Client Quotas (kafka-quotas/v1) API
  version: 1.0.0
extends: openapi/confluent-client-quotas-kafka-quotas-v1-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['/kafka-quotas/v1/client-quotas'].get
  update:
    x-apievangelist-phrasing:
      intent: List client quotas on a cluster
      effect: read
      questions:
      - Which client throughput quotas are set on my Dedicated Kafka cluster?
      - Can I list client quotas for one cluster in an environment?
      instructions:
      - text: List client quotas for cluster {cluster} in environment {environment}.
        slots:
          cluster: query.spec.cluster
          environment: query.environment
      - text: Show all throughput quotas on Kafka cluster {cluster}, environment {environment}.
        slots:
          cluster: query.spec.cluster
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka-quotas/v1/client-quotas'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a client quota
      effect: write
      questions:
      - How do I throttle a noisy client application with a new client quota?
      - Can I cap ingress and egress throughput for specific principals?
      instructions:
      - text: Create a client quota.
      - text: Set up a new throughput quota for a group of client principals.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka-quotas/v1/client-quotas/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one client quota
      effect: read
      questions:
      - What throughput limits does a particular client quota enforce?
      - Which principals does one client quota apply to?
      instructions:
      - text: Get client quota {id}.
        slots:
          id: path.id
      - text: Show the limits and principals of client quota {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka-quotas/v1/client-quotas/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a client quota
      effect: destructive
      questions:
      - Can I remove a client quota so those clients are no longer throttled?
      - How do I get rid of a quota I set by mistake?
      instructions:
      - text: Delete client quota {id}.
        slots:
          id: path.id
      - text: Remove the throttling quota {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka-quotas/v1/client-quotas/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a client quota
      effect: write
      questions:
      - Can I raise or lower the throughput limit on an existing client quota?
      - How do I add principals to a client quota that already exists?
      instructions:
      - text: Update client quota {id} with spec {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      - text: Change the throughput limits of quota {id} to {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'