Skip to content

Apache Kafka message binding

Contains information about the message representation in Apache Kafka.

Structure

copy

Examples

json
{
    "key": {
        "type": "string",
        "enum": [
            "myKey"
        ]
    },
    "schemaIdLocation": "payload",
    "schemaIdPayloadEncoding": "apicurio-new",
    "schemaLookupStrategy": "TopicIdStrategy",
    "bindingVersion": "0.3.0"
}

Migration guide

Added

schemaIdLocation

If a Schema Registry is used when performing this operation, tells where the id of schema is stored.

json
{
    "schemaIdLocation": { 
      "type": "string", 
      "description": "If a Schema Registry is used when performing this operation, tells where the id of schema is stored.", 
      "enum": ["header", "payload"] 
    } 
}

schemaIdPayloadEncoding

Number of bytes or vendor specific values when schema id is encoded in payload.

json
{
    "schemaIdPayloadEncoding": { 
      "type": "string", 
      "description": "Number of bytes or vendor specific values when schema id is encoded in payload."
    } 
}

schemaLookupStrategy

Freeform string for any naming strategy class to use. Clients should default to the vendor default if not supplied.

json
{
    "schemaLookupStrategy": { 
      "type": "string", 
      "description": "Freeform string for any naming strategy class to use. Clients should default to the vendor default if not supplied."
    } 
}