Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Applied Quotas (service-quota/v1) API

3 actions 3 updates phrasing extends openapi/confluent-the-data-streaming-platform-applied-quotas-service-quota-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 3

$.info
$.paths['/service-quota/v1/applied-quotas'].get
$.paths['/service-quota/v1/applied-quotas/{id}'].get

OpenAPI Overlay

Raw ↑
# 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 Applied Quotas (service-quota/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-applied-quotas-service-quota-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: 2
- target: $.paths['/service-quota/v1/applied-quotas'].get
  update:
    x-apievangelist-phrasing:
      intent: List applied service quotas
      effect: read
      questions:
      - What service quotas apply to my organization or environment?
      - Can I see the quota limits for a specific Kafka cluster?
      instructions:
      - text: List applied quotas for scope {scope}.
        slots:
          scope: query.scope
      - text: List {scope} quotas for Kafka cluster {kafka_cluster}.
        slots:
          scope: query.scope
          kafka_cluster: query.kafka_cluster
      - text: Show applied quotas at scope {scope} in environment {environment}.
        slots:
          scope: query.scope
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/service-quota/v1/applied-quotas/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one applied quota
      effect: read
      questions:
      - What is the current limit for a particular quota code?
      - Can I read a single applied quota by its quota code?
      instructions:
      - text: Show applied quota {id}.
        slots:
          id: path.id
      - text: Get quota {id} for environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      method: generated
      generated: '2026-09-26'