# kafka-proto-schemas

## Description

Common protobuf files to :
- Encode message in kafka producers
- Save schemas on kafka schema registry clusters

Registry clusters global compatibility is **BACKWARD_TRANSITIVE**

## Contribution

To add a new schema for a kafka topic, create a proto file (filename in snake case) in folder `schemas`.  
For `TestTopic` in package `ogury/tests` for example:  
- Create file `schemas/ogury/tests/test_topic.proto`
```
syntax = "proto3";

package ogury.tests;

message TestTopicMessage {

}
```
-  edit file `schemas.yml` to reference the schema:
```
TestTopic:
  filepath: "ogury/tests/test_topic.proto"
```

## Local Test

```
scripts/mock/mock-deployment.sh
```