better error handling when $ref references an external file in asyncapi
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.5k
- Forks
- 228
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 48
Description
Is your feature request related to a problem? Please describe.
I am building my pipelines to publish APIs and when I tried to bundle the asyncapi files I found the error below
Describe the solution you'd like
Support for bundling asyncapi files is the expected solution.
Describe alternatives you've considered
not much since bunding is the whole idea...
Additional context
The error shown now is:
Something went wrong when processing .\cache-messages-1.0.json:
- Cannot read properties of undefined (reading 'schemas')
Contributor 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.
Research direction
Start by reproducing bundling with an AsyncAPI file whose $ref points to an external JSON file, using the reported cache-messages-1.0.json case. Trace the undefined schemas error and determine the required external-reference handling; done means AsyncAPI files bundle without this error.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100