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

Document subscribing to events and entity states #15

Open
armiol opened this issue Apr 4, 2019 · 5 comments
Open

Document subscribing to events and entity states #15

armiol opened this issue Apr 4, 2019 · 5 comments

Comments

@armiol
Copy link
Contributor

armiol commented Apr 4, 2019

Until recently Stand API allowed to subscribe to the Entity state updates only. E.g.

"As a user I was able to subscribe to all changes of `Project` Aggregate with ID = 42."

However, it's been already a couple of months Spine users are able to subscribe to domain events as well. E.g.

"As a user I am able to subscribe to `TaskUpdated` events once they occur."

We need to mention that in a read-side API documentation. And have an code example illustrating the feature.

@meizabel meizabel self-assigned this Apr 5, 2019
@meizabel
Copy link
Contributor

meizabel commented Apr 9, 2019

I have a couple of questions related to the issue:

  1. Should we mention it in Model Definition Guide or somewhere else on the site? Please clarify.
  2. Also, could you please provide a code sample for the feature?

@meizabel
Copy link
Contributor

@armiol
Could you please respond to my questions above? Thanks in advance!

@armiol
Copy link
Contributor Author

armiol commented Apr 30, 2019

@meizabel please find my answers below.

  1. Yes, the Model Definition Guide should have a section called "Subscriptions" below the "Queries". In scope of this section, we are going to speak of Stand and its functionality, including an ability for API clients to subscribe to both entity state changes and domain events.
  2. The code sample for the feature is basically the same as the code of subscribing to entity state via Stand. Once we have an illustrative example of subscriptions, we will have the code sample requested as well.

@meizabel
Copy link
Contributor

@armiol
Do we have illustrative examples of subscriptions now?

@armiol
Copy link
Contributor Author

armiol commented Apr 11, 2020

We need to have a code sample in the Stand documentation. And have an article on subscriptions from the client-side in the documentation.

@alexander-yevsyukov alexander-yevsyukov changed the title Mention that Stand is able to deliver both Entity state updates and domain events Document subscribing to events and entity states Aug 14, 2020
@alexander-yevsyukov alexander-yevsyukov self-assigned this Aug 14, 2020
@alexander-yevsyukov alexander-yevsyukov transferred this issue from SpineEventEngine/SpineEventEngine.github.io Jan 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

3 participants