AsyncAPI Developer Network

Appearance

Apache Kafka channel binding ​

Contains information about the message representation in Apache Kafka.

Structure ​

copy
{
$schema:"http://json-schema.org/draft-07/schema#"
$id:"http://asyncapi.com/bindings/kafka/0.5.0/channel.json"
title:"Channel Schema"
description:"This object contains information about the channel representation in Kafka."
type:"object"
additionalProperties:false
patternProperties:{...}
properties:{...}
examples:[...]
}

Examples ​

json
{
    "topic": "my-specific-topic",
    "partitions": 20,
    "replicas": 3,
    "bindingVersion": "0.5.0"
}

Changelog ​

Changed ​

topicConfiguration.additionalProperties ​

Topic configuration can be extended

json
{
    "description": "Topic configuration properties that are relevant for the API.",
    "type": "object",
    "additionalProperties": false, 
    "additionalProperties": true
}

Added ​

topicConfiguration.confluent.key.schema.validation ​

It shows whether the schema validation for the message key is enabled. Vendor specific config.

For more details: https://docs.confluent.io/platform/current/installation/configuration/topic-configs.html#confluent-key-schema-validation

json
{
    "description": "Topic configuration properties that are relevant for the API.",
    "type": "object",
    "properties": {
        "confluent.key.schema.validation": { 
            "description": "It shows whether the schema validation for the message key is enabled. Vendor specific config. For more details: (https://docs.confluent.io/platform/current/installation/configuration/topic-configs.html#confluent-key-schema-validation)", 
            "type": "boolean"
        } 
    }
}

topicConfiguration.confluent.key.subject.name.strategy ​

The name of the schema lookup strategy for the message key. Vendor specific config.

For more details: https://docs.confluent.io/platform/current/installation/configuration/topic-configs.html#confluent-key-subject-name-strategy

json
{
    "description": "Topic configuration properties that are relevant for the API.",
    "type": "object",
    "properties": {
        "confluent.key.subject.name.strategy": { 
            "description": "The name of the schema lookup strategy for the message key. Vendor specific config. For more details: (https://docs.confluent.io/platform/current/installation/configuration/topic-configs.html#confluent-key-subject-name-strategy)", 
            "type": "string"
        } 
    }
}

topicConfiguration.confluent.value.schema.validation ​

It shows whether the schema validation for the message value is enabled. Vendor specific config.

For more details: https://docs.confluent.io/platform/current/installation/configuration/topic-configs.html#confluent-value-schema-validation

json
{
    "description": "Topic configuration properties that are relevant for the API.",
    "type": "object",
    "properties": {
        "confluent.value.schema.validation": { 
            "description": "It shows whether the schema validation for the message value is enabled. Vendor specific config. For more details: (https://docs.confluent.io/platform/current/installation/configuration/topic-configs.html#confluent-value-schema-validation)", 
            "type": "boolean"
        } 
    }
}

topicConfiguration.confluent.value.subject.name.strategy ​

The name of the schema lookup strategy for the message value. Vendor specific config.

For more details: https://docs.confluent.io/platform/current/installation/configuration/topic-configs.html#confluent-value-subject-name-strategy

json
{
    "description": "Topic configuration properties that are relevant for the API.",
    "type": "object",
    "properties": {
        "confluent.value.subject.name.strategy": { 
            "description": "The name of the schema lookup strategy for the message value. Vendor specific config. For more details: (https://docs.confluent.io/platform/current/installation/configuration/topic-configs.html#confluent-value-subject-name-strategy)", 
            "type": "string"
        } 
    }
}