> For the complete documentation index, see [llms.txt](https://adidas.gitbook.io/api-guidelines/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://adidas.gitbook.io/api-guidelines/asynchronous-api-guidelines/kafka-asynchronous-guidelines/j_channels.md).

# Channels

All AsyncAPI specs **MUST** include definitions for the channels (Kafka topics) including:

* Description of the topic
* Servers in which the topic is available
  * This is a reference to one of the server identifiers included in the servers section
* publish/subscribe operations
  * Operation ID
  * Summary or short description for the operation
  * Description for the operation
  * Security schemes
  * Tags
  * External Docs
  * Message details

In addition to those supported fields, it **MAY** be possible to use extension attributes (using the x- prefix) to specify specific configuration parameters and metadata. In so, the recommended attributes to use are:

* x-metadata
  * To include additional configuration specific to your team or project
* x-configurations
  * To include Kafka configuration parameters and producers/consumers

As the parameters can be different per environment, it is very convenient to add an additional level for the environment.

As part of the publish/subscribe operations, the spec **SHOULD** specify the different Kafka clients currently consuming from the different topics for each cluster/environment. For this, the extended attributes x-producers and x-consumers will be used.

```yaml
...
channels:
  namespace.source.event.topic-name:
    description: 'A description of the purpose of the topic and the contained information'
    servers: ['playground-dev', 'playground-sit', 'playground-pro']
    x-metadata:
      myField1: 'myValue1'
      myField2: 'myValue2'
    x-configurations:
      playground.dev:
        kafka:
          partitions: '12'
          replicas: '1'
          topicConfiguration:
            min.insync.replicas: '1'
            retention.ms: '2592000000'
      playground.sit:
        kafka:
          partitions: '12'
          replicas: '2'
          topicConfiguration:
            min.insync.replicas: '1'
            retention.ms: '2592000000'
     publish:
      operationId: 'producer'
      summary: 'Description for the operation'
      description: 'An extensive explanation about the operation'
      security:
        - producerAcl: []
      tags:
        - name: 'tagA'
        - name: 'tagB'
      x-producers:
        playground.dev:
          - 'producer1'
          - 'producer2'
        playground.sit:
          - 'producer1'
          - 'producer2'
        playground.pro:
          - 'producer3'
          - 'producer4'
      externalDocs:
        description: 'documentation'
        url: 'http://confluence.adidas.fdp/catalogue/myTopic'
      ...
    subscribe:
      operationId: 'consumer'
      ...
      x-consumers:
        playground.dev:
          - 'consumer1'
          - 'consumer2'
        playground.sit:
          - 'consumer1'
          - 'consumer2'
        playground.pro:
          - 'consumer3'
...
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://adidas.gitbook.io/api-guidelines/asynchronous-api-guidelines/kafka-asynchronous-guidelines/j_channels.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.