Skip to content

[DOCS] Global view of Services & NATS Events #1

@SchulzeStTSI

Description

@SchulzeStTSI

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:

Suggested Fix

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions