Added documentation on Event Schema and Namespace guide #307
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
victorskl
commented
May 18, 2024
victorskl
commented
- Improved repo landing README.md
* Improved repo landing README.md
This was referenced May 18, 2024
reisingerf
approved these changes
May 20, 2024
| ### Multiple Service Schemas | ||
|
|
||
| - Multiple services may publish the same or similar schema due to similarity of their domain modelling aspect. | ||
| - The event schema discriminator is the event `source` property of the event message instance. |
There was a problem hiding this comment.
Perhaps mention 'detail-type' here?
The source is only one dimension and a service can also emit different events types, i.e. multiple detail-types from the same source. Both together define the event schema.
|
|
||
| ## Namespace | ||
|
|
||
| Service namespaces are for filtering Event Rule purpose. This is used in event `source` property when service emits messages. It denotes where the message is originating from. The convention follows reverse domain name. We follow "compat" format of [CDK stack directory name](../../lib/workload/stateless/stacks). i.e. Removing dash character from kebab-case. |
There was a problem hiding this comment.
Ditto, also use detail-type (see naming of examples)
mmalenic
approved these changes
May 20, 2024
|
We are going to rearrange this REAME a little bit in next PR. Merging it as-is for now and, doing minor edit in next PR. Merging... |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.