jmcarp / jmcarp/flask-apispec

How to add "examples" to "responses"?

Open
#115 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
652
Forks
151
PR merge metrics
No merged PRs in 30d

Description

Hi,
I want to add "examples" to the "responses" of each "code". But I did not find any documentation talking about this?

Sample:
![image](https://user-images.githubusercontent.com/9206452/44941958-b1597480-add1-11e8-9ff7-ab205c0c3024.png)

Contributor guide

No contributing guide indexed for this repository

Research direction

The report names no file, test, or entry point, so start by locating the response-generation and documentation code in the repository. Document the supported way to add examples to each response code, with a confirming example or test showing the resulting output.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.