Confluent | the Data Streaming Platform · 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-the-data-streaming-platform-client-quotas-kafka-quotas-v1-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['/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-the-data-streaming-platform-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 Kafka cluster?
      - Can I see every client quota in an environment?
      instructions:
      - text: List the client quotas for cluster {cluster} in environment {environment}.
        slots:
          cluster: query.spec.cluster
          environment: query.environment
      - text: Show all quotas on {cluster}.
        slots:
          cluster: query.spec.cluster
      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 limit the throughput of a specific client application?
      - Can I add a new produce and consume quota for a group of principals?
      instructions:
      - text: Create a new client quota.
      - text: Add a throughput quota for a set of principals on my cluster.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka-quotas/v1/client-quotas/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a client quota
      effect: read
      questions:
      - What throughput limits does one client quota enforce?
      - Can I look up a client quota by its ID?
      instructions:
      - text: Get client quota {id}.
        slots:
          id: path.id
      - text: Show the throughput limits in 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 quota so a client is no longer throttled?
      - Is deleting a client quota immediate?
      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 the throughput limit on an existing client quota?
      - How do I add principals to a quota I already created?
      instructions:
      - text: Update client quota {id} with spec {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      - text: Change the throughput limits on quota {id} to {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'