ReDoc generates "Request samples" for request body but not for query string
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
ReDoc automagically generates a request sample using the schema provided to describe the request body, which is nice. However, it does not generate such examples for query parameters.
Maybe I'm doing things wrong. Feel free to requalify as question or feature request.
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 tracing how ReDoc generates request samples from request-body schemas, then compare that path with the OpenAPI query-parameter data described in the issue. Done means query parameters also produce a visible request sample, with coverage added for the behavior; no source file or test is named in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, react, typescript
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100