Strimzi Topics API

openapi: 3.1.0
info:
  title: Strimzi Kafka Bridge REST Consumer Topics API
  description: The Strimzi Kafka Bridge provides an HTTP/REST interface to Apache Kafka. It allows HTTP clients to produce and consume messages, manage consumer group subscriptions, and query topic metadata without needing a native Kafka client library. The Bridge acts as a protocol translator between HTTP and the Kafka protocol. Deploy via the KafkaBridge custom resource.
  version: 0.28.0
  contact:
    name: Strimzi Community
    url: https://strimzi.io
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:8080
  description: Kafka Bridge (default local port)
tags:
- name: Topics
  description: Endpoints for querying Kafka topic metadata including partition counts, offsets, and configuration.
paths:
  /topics:
    get:
      operationId: listTopics
      summary: List Topics
      description: Returns a list of all topic names available in the Kafka cluster.
      tags:
      - Topics
      responses:
        '200':
          description: A list of topic names
          content:
            application/vnd.kafka.v2+json:
              schema:
                type: array
                items:
                  type: string
  /topics/{topicname}/partitions:
    get:
      operationId: listPartitions
      summary: List Topic Partitions
      description: Returns partition metadata for all partitions of a topic, including leader, replicas, and in-sync replicas.
      tags:
      - Topics
      parameters:
      - name: topicname
        in: path
        required: true
        description: The name of the Kafka topic
        schema:
          type: string
      responses:
        '200':
          description: Partition metadata
          content:
            application/vnd.kafka.v2+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Partition'
        '404':
          $ref: '#/components/responses/TopicNotFound'
  /healthy:
    get:
      operationId: healthy
      summary: Check Bridge Health
      description: Returns HTTP 200 if the Bridge is healthy and connected to Kafka.
      tags:
      - Topics
      responses:
        '200':
          description: Bridge is healthy
        '503':
          description: Bridge is not healthy
  /ready:
    get:
      operationId: ready
      summary: Check Bridge Readiness
      description: Returns HTTP 200 if the Bridge is ready to accept requests.
      tags:
      - Topics
      responses:
        '200':
          description: Bridge is ready
        '503':
          description: Bridge is not ready
components:
  responses:
    TopicNotFound:
      description: Topic not found
      content:
        application/vnd.kafka.v2+json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Partition:
      type: object
      properties:
        partition:
          type: integer
          description: The partition ID
        leader:
          type: integer
          description: The broker ID of the partition leader
        replicas:
          type: array
          items:
            type: object
            properties:
              broker:
                type: integer
              leader:
                type: boolean
              in_sync:
                type: boolean
    Error:
      type: object
      properties:
        error_code:
          type: integer
          description: The error code
        message:
          type: string
          description: A human-readable error message
externalDocs:
  description: Strimzi Kafka Bridge Documentation
  url: https://strimzi.io/docs/bridge/latest/