swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector V1metadata API
  description: Get the metadata of topic and partition
schemes:
- https
tags:
- name: V1metadata
  description: Get the metadata of topic and partition
paths:
  /v1/metadata/brokers:
    get:
      tags:
      - V1metadata
      summary: Microsoft Azure Get A List Of Kafka Brokers
      description: Get a list of Kafka brokers with hostname, port, and broker id
      operationId: microsoftAzureMetadataGetbrokers
      consumes:
      - application/json
      produces:
      - application/json
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/BrokerResponse'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '405':
          description: Method Not Allowed
        '500':
          description: Internal Server Error
  /v1/metadata/topics:
    get:
      tags:
      - V1metadata
      summary: Microsoft Azure Get A List Of Kafka Topics
      description: Get a list of Kafka topics. If it is a newly created topic, please wait a few seconds for it to show up.
      operationId: microsoftAzureMetadataGettopics
      consumes:
      - application/json
      produces:
      - application/json
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/TopicListResponse'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '405':
          description: Method Not Allowed
        '500':
          description: Internal Server Error
  /v1/metadata/topics/{topic}/partitions:
    get:
      tags:
      - V1metadata
      summary: Microsoft Azure Get Metadata About All Partitions For A Specific Topic
      description: Get metadata about all partitions for a specific topic with partition ID, earliest offset, latest offset, leader, replicas, and in-sync replicas
      operationId: microsoftAzureMetadataGettopicpartitions
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: topic
        in: path
        description: Name of the topic
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/TopicMetadaResponse'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '405':
          description: Method Not Allowed
        '500':
          description: Internal Server Error
  /v1/metadata/topics/{topic}/partitions/{partition}:
    get:
      tags:
      - V1metadata
      summary: Microsoft Azure Get Metadata About A Specific Kafka Topic Partition
      description: Get metadata about a specific Kafka topic-partition with partition ID, earliest offset, latest offset, leader, replicas, and in-sync replicas
      operationId: microsoftAzureMetadataGetmetadataforpartition
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: topic
        in: path
        description: Name of the topic
        required: true
        type: string
      - name: partition
        in: path
        description: Partition ID to get metadata for
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/PartitionMetadataResponse'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '405':
          description: Method Not Allowed
        '500':
          description: Internal Server Error
definitions:
  PartitionMetadataResponse:
    type: object
    properties:
      partition_id:
        type: integer
        format: int32
        description: Partition ID
      earliest_offset:
        type: integer
        format: int64
        description: Earliest offset for the topic-partition
      latest_offset:
        type: integer
        format: int64
        description: Latest offset for the topic-partition
      leader:
        description: Leader broker endpoint for the topic-partition
        $ref: '#/definitions/BrokerEndpoint'
      replicas:
        type: array
        description: List of replica broker endpoints for the topic-partition
        items:
          $ref: '#/definitions/BrokerEndpoint'
      isr:
        type: array
        description: List of broker endpoints of in-sync replicas for the topic-partition
        items:
          $ref: '#/definitions/BrokerEndpoint'
    description: Metadata information about a topic-partition
  BrokerEndpoint:
    type: object
    properties:
      hostName:
        type: string
        description: HostName for Kafka broker endpoint
      port:
        type: integer
        format: int32
        description: Port for Kafka broker endpoint
      id:
        type: integer
        format: int32
        description: Broker ID for Kafka broker endpoint
      rack:
        type: string
        description: Rack ID for Kafka broker endpoint
    description: Kafka broker endpoint
  TopicMetadaResponse:
    type: object
    properties:
      topic:
        type: string
        description: Name of the topic
      partitions:
        type: array
        description: List of partition metadata
        items:
          $ref: '#/definitions/PartitionMetadataResponse'
    description: Metadata about a specific topic
  BrokerResponse:
    type: object
    properties:
      brokers:
        type: array
        description: List of Kafka broker endpoints
        items:
          $ref: '#/definitions/BrokerEndpoint'
    description: List of Kafka broker endpoints
  TopicListResponse:
    type: object
    properties:
      topics:
        type: array
        description: List of topic names
        uniqueItems: true
        items:
          type: string
    description: List of topics
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'