-
Notifications
You must be signed in to change notification settings - Fork 3
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Location in Docs
OCM Docu
What's wrong?
Description:
We need to document all NATS events we have going around in our system to ensure we do not create collisions, or miss crucial events.
Documentation example:
Events should be described as follows:
## TOPIC/EVENT: <topicname>/<eventname>
<Describe the purpose of the event>
### Consuming Services:
- <list each consuming service>
### Producing Services:
- <list each producting service>
- <any events that could trigger this event>
### Payload Description:
<details><summary>Click to expand</summary>
<paste json example>
</details>Acceptance Criteria:
- NATS events are documented in file
messages-documentation/wstack/eventList.mdin https://gitlab.eclipse.org/eclipse/xfsc/libraries/messaging/cloudeventprovider repository - All events used at the time of work on this issue must be documented according to the example above.
Suggested Fix
No response
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation