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

Group the generated events from the AsyncAPI in some neatly organized manner. #13

Open
hartmanjan1970 opened this issue Nov 25, 2024 · 4 comments

Comments

@hartmanjan1970
Copy link

Use Case

In the UI view http://localhost:3000/docs under topic Events() the number of events is now a large list of all events produced by all In In my test situation it are already 101 events/commands

We use EventCatalog to get overview of all the events in the system, so i want to propose some kind of organization to the generated events/commands.
image

Proposed Solution

Would it be an option to generate the events/command in a sub directory?

A way of organization could be:
Place the events in a directory by service name.
And maybe secondly a sub-directory of the producing channel name.
So we end up with something like:
events\{service_a}\{channel X}\
events\{service_a}\{channel Y}\
events\{service_b}\{channel Z}\

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.
@hartmanjan1970 hartmanjan1970 changed the title Group the generated events from the AsyncAPI in some neatly organizated manner. Group the generated events from the AsyncAPI in some neatly organized manner. Nov 25, 2024
@boyney123
Copy link
Contributor

Would this work event-catalog/eventcatalog#957?

Moving generators to nested folder structures by default

@hartmanjan1970
Copy link
Author

hartmanjan1970 commented Dec 20, 2024

This would work for us, no problem if we have to add a flag in the configuration or if it is a default behavior

@hartmanjan1970
Copy link
Author

hartmanjan1970 commented Jan 31, 2025

Is there any movement in this issue?
For us it would resolve a lot of overlapping GET request between the services.
We have multiple services which implement the same GET / PUT pattern and because the pattern is identical the rest queries are named the same and so in EventCatlog overwriting each other at the moment

@carlosallexandre
Copy link

If possible,
Assign to me 🙏

@boyney123 boyney123 transferred this issue from event-catalog/generator-asyncapi Feb 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants