api-guidelines icon indicating copy to clipboard operation
api-guidelines copied to clipboard

[new rule] guidelines for avro format

Open BirgitBader opened this issue 2 years ago • 0 comments

(i) This issue has been manually transferred from a former internal repository, as a private repository issue cannot be transferred to a public repository.

Context

Multiple teams expressed the desire to use something other than JSON to encode messages on Kafka. While the Event-Guidelines does not restrict the usage of another format, it also provides no guidance how to properly use another format.

As most of the kafka ecosystem is working with avro, we will focus on the evaluation of guidelines for the avro format.

Tasks

  • [ ] Check the existing guidelines for JSON if they also apply to the avro format.
  • [ ] Check if additional rules make sense
  • [ ] Update the guidelines accordingly to include rules for Avro

Reference

  • https://avro.apache.org/

BirgitBader avatar May 16 '23 07:05 BirgitBader