event-catalog / event-catalog/generators

AsyncAPI: Support Specification Extensions

Open
#243 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
15
Forks
16
Avg merge
25m
Merged PRs (30d)
4

Description

### Use Case

I'd like to show information from own [AsyncAPI Specification Extensions](https://www.asyncapi.com/docs/concepts/asyncapi-document/extending-specification).

My exact use case is `x-content-schema` https://github.com/freaz/eventcatalog-bug-reporting/blob/main/asyncapi.yaml#L48-L54

But there will be other usecases for `x-` support to avoid need to go to rendered AsyncAPI and looking for the Message.

### Proposed Solution

Perhaps somthing similar as in asyncapi-react would be enough.

https://freaz.github.io/eventcatalog-bug-reporting/docs/services/Example%20Service/1.0.0/asyncapi/asyncapi/#message-ExampleEvent
Image

### Implementation Notes

It will need to distinguish between user extensions and EventCatalog's `x-eventcatalog-*`.

### 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](https://discord.com/invite/3rjaZMmrAm).

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.