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 OpenAPI by the owning service #1065

Open
hartmanjan1970 opened this issue Dec 20, 2024 · 2 comments
Open

Comments

@hartmanjan1970
Copy link

hartmanjan1970 commented Dec 20, 2024

Use Case

In the UI view http://localhost:3000/docs under topic Queries () the number of queries is now a large list of all queries from all the OpenAPI contracts from all our services.

We have multiple services with there own OpenAPI contract.
In every service we use the same query pattern, therefor the queries have the same name.
Problem arise when we generate with OpenAPI generator the Queries, the 2nd query will override the first one.

Proposed Solution

Would it be possible to arrange the queries by the services the contracts belongs to?
queries{service name a}{the queries for this service}
queries{service name b}{the queries for this service}

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.
@boyney123
Copy link
Collaborator

Yeah good points, I wonder if we should enable a new sidebar configuration folks can opt into.

At the moment the sidebar lists things by resource type as you mentioned, but maybe we could group them by domain/service too?

Example

My Domain
  - Service A
      - Events
      - Queries
      - Commands
  - Service B
     - Events

My Second Domain
  - Service C
  - Service D
  
etc....

Would this kinda of navigation be better?

@hartmanjan1970
Copy link
Author

I think your example would be good for us

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

2 participants