otto-de / otto-de/api-guidelines
[new rule] producers must specify order guarantee in AsyncAPI spec
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 50
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Description
(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
If the producer guarantees that messages are not sent out-of-order, consumers can more easily consume topics.
This ticket explores if this needs to be part of the contract between the producer and consumer (i.e. AsyncAPI spec).
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 reviewing the existing API guidelines and the AsyncAPI contract context described in this issue. Determine whether producer ordering guarantees belong in the specification, then document the agreed rule and its expected producer and consumer behavior; the issue is done when that decision is recorded clearly.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100