Skip to content

AsyncAPI: Support Specification Extensions #243

@freaz

Description

@freaz

Use Case

I'd like to show information from own AsyncAPI Specification Extensions.

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions