Skip to content
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

add diagram showing how to consume the journal api #58

Open
alexkli opened this issue Jul 28, 2020 · 1 comment
Open

add diagram showing how to consume the journal api #58

alexkli opened this issue Jul 28, 2020 · 1 comment
Assignees

Comments

@alexkli
Copy link

alexkli commented Jul 28, 2020

The journaling api doc could use a diagram showing how to consume the journal api.

It is non trivial and everyone who worked on our end on a journal client found it extremely helpful to have such a diagram since just the available textual documentation isn’t enough for getting a proper understanding. And the retry logic can be easily misunderstood from my experience.

Here is an example flow (petri-net) diagram: adobeio-journal-v2-diagram.zip

But don't take it literally - it is slightly out of date. An IO Events engineer should first ensure it is correct.

(The zip contains both visio sources and a png)

@kgera
Copy link
Collaborator

kgera commented Jul 31, 2020

Thanks @alexkli will get it reviewed and then update.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants