jmcarp / jmcarp/flask-apispec

How to document multiple api methods

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

Description

How can we document multiple api methods on the same route:
e.g
```python
@api.route('/abc/', methods=['GET', 'POST'])
def some_func(val):
return blah blah
```
Now i have i have documented the **GET** one, but i want to document POST separately. I'm getting the same description and params etc in **POST** as well.

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue names a route using GET and POST and shows a single function, but it identifies no source file or test. Start by reproducing that route and reviewing how its documentation metadata is collected. Done means the GET and POST methods can have separate descriptions and parameters, with coverage for both methods.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.