Add $ref resolution to JSON schemas
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 134
- Forks
- 87
- Avg merge
- 12m
- Merged PRs (30d)
- 25
Description
Problem
admin-api-schema's get() method returns raw json schemas without resolving definitions used in $ref. This makes get method hardly usable if somebody needs to see whole schema (for example when used in documentation). More on this read this comment.
Solution
One of possible solutions could be adding $ref resolution through package like ref-parser. But more research should be done into use-cases and other solutions first
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 with packages/admin-api-schema/lib/index.js around the get() method and review the linked comment for current schema behavior. Research the stated use cases and compare $ref resolution options, including ref-parser. Done means get() provides whole schemas with definitions resolved and the chosen behavior is covered by appropriate tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, node.js
- Domain
- api
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100