AsyncAPI: Support Specification Extensions
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- typescript
- Domain
- backend-api-design
Research direction
Start with the linked asyncapi.yaml lines 48-54 and compare the referenced asyncapi-react rendering for the x-content-schema extension. Then locate the generator's AsyncAPI rendering entry point; done means user-defined x- extensions are surfaced while x-eventcatalog-* extensions remain distinct.
Written by the indexing model from the issue text.
Description
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.
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.
- Dominant language
- TypeScript
- Stars
- 16
- Forks
- 15
- Avg merge
- 3m
- Merged PRs (30d)
- 7
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- No contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from event-catalog/generators
-
Difficulty 4/5 3-5 days Newbie friendliness 56/100
event-catalog/generators#458 ·
-
generator-asyncapi: option to default message (and channel) versions to the document's info.versionOpen
Difficulty 4/5 3-5 days Newbie friendliness 55/100
event-catalog/generators#457 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
event-catalog/generators#451 · 1 reaction ·
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
event-catalog/generators#450 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
event-catalog/generators#449 · 1 comment ·
All issues in event-catalog/generators
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
hugomrdias/playwright-test#753 ·
Maintainers usually reply within 1 day
-
Review view: Daily/Weekly Review header buttons use the app-wide toolbar control stylePossibly taken @colherdesopa claimed this today. Open
Difficulty 1/5 1-3 hours Newbie friendliness 90/100
dongdongbh/Mindwtr#1515 ·
Maintainers usually reply within 1 day
-
pending-triage
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
kirodotdev/Kiro#12301 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 83/100