Document events directly into domains (without services)

[boyney123]

Use Case

Speaking to a few folks, so capturing this here, and curious if you would find it useful to, if you do upvote this issue.

This feature would let people document events directly inside domains.

At the moment the relationship in EventCatalog is domains > services > messages.

This new proposal would like people do domains > events.

How it would work is simple, a folder domain/MyDomain/events and the events would be rendered in the Catalog.

Similar #545

Proposed Solution

No response

Implementation Notes

No response

Community Notes

• Please vote by adding a 👍 reaction to the issue to help us prioritize.
• If you are interested to work on this issue, please leave a comment.
• If this issue is labeled needs-discussion, it means the spec has not been finalized yet. Please reach out in the EventCatalog Discord.

[carlosallexandre]

The mapCatalogToAstro supports this as it resolves the path from right to left. All it needs is find the reserved keywords whenever it is placed, like below:

• events/MyEvent/index.md turns in events/MyEvent/index.mdx
• services/MyService/events/MyEvent/index.md turns in events/MyEvent/index.mdx
• domains/MyDomain/services/MyService/events/MyEvent/index.md turns in events/MyEvent/index.mdx

The image below is an example:

But we have a bug...

1. Run the default example in the development mode npx eventcatalog dev
2. Add an empty dir domains/Orders/events/.
3. The watcher will try create a public/generated/events/ overriding the already created from the hydration phase. Throwing an error.

[otbe]

2 things come to my mind:

1. I think whatever we do here we should avoid breaking old URLs. Lets say when I move MyEvent from /events/MyEvent to domains/MyDomain/events/MyEvent it would be nice if events/MyEvent still works afterwards.
2. This only provides real value when we also show this relationship to the user. E.g. a dedicated section in the event page sidebar which states what domain this event belongs to, column/filter in discover/events, a section of events in this domain on the domain page, etc.

Both could be accomplished by simply adding a new frontmatter key to the event spec that allows you to define a domain which then creates the relationship 🤔

[XaaXaaX]

Just something in mind,

Today the messages are under a service spec documentation openapi/asyncapi, etc.
what will happen to that relationship?

I think messages are a collection representing a service contract