Generate JSON schema from response schema
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
Describe the problem to be solved
Generating JSON schema from response schema might be helpful for some developers especially frond-end developers to develop UI component based on JSON schema.
Check this repo react-jsonschema-form to see a possible scenario.
Describe the solution you'd like
- Add capability to convert response schema to JSON schema.
- Display generated JSON schema along side the “Response samples" panel, maybe with a "Copy" button or extra "Download" button.
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 locating the response schema handling and the “Response samples” panel in the Redoc codebase. Define how response schemas should be converted to JSON Schema, then verify that the generated schema is displayed beside the samples with the requested copy or download action.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- api, documentation, frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100