Response Examples
- Dominant language
- TypeScript
- Stars
- 49
- Forks
- 26
- Avg merge
- 3d 21h
- Merged PRs (30d)
- 4
Description
> ℹ️ _This issue was partially AI-generated and may contain technical inaccuracies._
**Is your feature request related to a problem? Please describe.**
Requests cannot store example responses, so there is no built-in documentation of expected responses and no source for a mock server.
**Describe the solution you'd like**
Allow saving one or more example responses per request (status, headers, body), shown alongside the request as documentation.
**Describe alternatives you've considered**
Keeping examples in external docs or comments.
**Additional context**
Foundation for the Mock Server (#842) and API Docs auto-generation (#859).
Contributor guide
Research direction
The issue names no files or tests. Start by locating how requests are stored and displayed, then determine where example responses belong and how they should appear alongside a request. Done means one or more examples can be saved with status, headers, and body, and are available as request documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100