OpenBankProject / OpenBankProject/OBP-API
Introduce versioning to Kafka messages
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 1.7k
- Forks
- 482
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 15
Description
Suggestion for versioning of Kafka messages:
After input from Ulrich, send version with the message - so we don't rely on the transport (Kafka)
{"version" : "k0.1.0"}
Use "k" to denote that this is separate to the api version (v)
if k0.1.0 is requested, then we expect the answer to be in k0.1.0
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing how Kafka messages are produced and consumed in the Scala project, then compare that path with the existing API version handling. Define where the k-prefixed version belongs, how a requested version selects the response version, and how compatibility is verified; done means producers and consumers consistently exchange and honor the message version.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kafka, scala
- Domain
- distributed-systems
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100