Skip to content

Commit 2c4cc3e

Browse files
committed
Add documentation for User* routes.
1 parent e0e403d commit 2c4cc3e

File tree

3 files changed

+330
-4
lines changed

3 files changed

+330
-4
lines changed

src/api/endpoints.py

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ def version():
2424
---
2525
responses:
2626
200:
27-
description: Everything went alright
27+
description: List of versions of dependencies
2828
"""
2929
return jsonify({
3030
"python_version": "{}.{}".format(version_info.major, version_info.minor),
@@ -61,8 +61,18 @@ def version():
6161
"werkzeug_version": "{}".format(pkg_resources.get_distribution('werkzeug').version)
6262
})
6363

64-
@app.route("/swagger_spec")
64+
@app.route("/spec")
6565
def spec():
66+
"""
67+
API spec
68+
Return the swagger api specification.
69+
---
70+
tags:
71+
- Docs
72+
responses:
73+
200:
74+
description: API spec documentation
75+
"""
6676
swag = swagger(app)
6777

6878
swag['swagger'] = '2.0'

0 commit comments

Comments
 (0)