-
Notifications
You must be signed in to change notification settings - Fork 14
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(guidelines): add new rule for sending durable event ids #77
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I feel this is strongly related to idempotency. What do you think about linking the article?
https://github.com/otto-de/api-guidelines/blob/15c925dedcb3d474b17d33fc35fc6015f5289c2c/dev-context/async/03-decisions/consumption-idempotency.md
The dev-context section is not linkable in our API portal. But feel free to link the corresponding guideline: https://api.otto.de/portal/guidelines/r200002 |
Like that rule, maybe we could also add a link to https://api.otto.de/portal/guidelines/event-guidelines/concepts#events as we already quote it. |
Hi @JanKlasser3000 , thanks for this PR 🚀 For the Changelog (PR body): New
For the PR title (I know, we don't have a convention for that yet, but ...😉) feat(guidelines): add new rule for sending durable event ids |
api-guidelines/async/semantics/event-structure/rules/should-send-durable-event-ids.md
Outdated
Show resolved
Hide resolved
api-guidelines/async/semantics/event-structure/rules/should-send-durable-event-ids.md
Outdated
Show resolved
Hide resolved
api-guidelines/async/semantics/event-structure/rules/should-send-durable-event-ids.md
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@JanKlasser3000 I've made some remarks.
Thanks for all the input and I will do the changes about the wording. I agree about the correlation for the differenct sections, however I think it can also be confusing to add to many links and makes it a bit hard to get an overview. Could we also move the concept in the menu up, so its clear its valid for all the rules? For the idempotency a link can be useful, maybe the other way round, to indicate that event IDs can be used for idempotency checking? As for the title, its the best I could come up with, however I am open for suggestions |
Linking the other way around makes sense to me. For me, it's also okay to leave the link to the events section to not overwhelm the reader. |
I changed the PR, ready for approval ( in case nothing new is requested ) |
Changelog:
New