Automatically select the corresponding response when an example request is selected
Open
Nobody has claimed this yet.
Type: Enhancement
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
Our OpenAPI 3 documentation has multiple examples for some complex endpoints, which come in pairs sharing the same name. It would be really useful if there was an option to have the corresponding response selected when the user selects a request or vice versa.
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
The issue names no files, tests, or entry points. Start by locating the OpenAPI 3 example-selection UI and its tests; done means selecting a request selects the same-named response, and selecting a response selects the request for paired examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, frontend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100