# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure Kafka Restproxy V1metadata API
  version: 1.0.0
extends: openapi/microsoft-azure-v1metadata-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: 4
- target: $.paths['/v1/metadata/brokers'].get
  update:
    x-apievangelist-phrasing:
      intent: List Kafka brokers
      effect: read
      questions:
      - What Kafka brokers are in my cluster, and on which hosts and ports?
      - Can I get each broker's ID from the Kafka REST proxy?
      instructions:
      - text: List the Kafka brokers with their hostname, port and broker ID.
      - text: Show me every broker in the Kafka cluster.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/metadata/topics'].get
  update:
    x-apievangelist-phrasing:
      intent: List Kafka topics
      effect: read
      questions:
      - Which Kafka topics exist in my cluster?
      - Why doesn't a topic I just created show up in the topic list yet?
      instructions:
      - text: List all Kafka topics in the cluster.
      - text: Show me the names of every Kafka topic.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/metadata/topics/{topic}/partitions'].get
  update:
    x-apievangelist-phrasing:
      intent: List partitions of a Kafka topic
      effect: read
      questions:
      - How do I see the earliest and latest offsets for every partition of a Kafka topic?
      - Which broker leads each partition of my topic, and are replicas in sync?
      instructions:
      - text: List all partitions of Kafka topic {topic} with offsets and leaders.
        slots:
          topic: path.topic
      - text: Show the in-sync replicas for each partition of topic {topic}.
        slots:
          topic: path.topic
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/metadata/topics/{topic}/partitions/{partition}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metadata for one Kafka topic partition
      effect: read
      questions:
      - What are the earliest and latest offsets of one specific topic partition?
      - Who is the leader for a single Kafka partition right now?
      instructions:
      - text: Get metadata for partition {partition} of Kafka topic {topic}.
        slots:
          partition: path.partition
          topic: path.topic
      - text: Show the leader and replicas of topic {topic} partition {partition}.
        slots:
          topic: path.topic
          partition: path.partition
      method: generated
      generated: '2026-09-26'