From 1597f233e2b2228291eabe5bd03edb8da51183ae Mon Sep 17 00:00:00 2001
From: Joseph Weston <joseph.weston08@gmail.com>
Date: Tue, 16 Jan 2018 18:17:54 +0100
Subject: [PATCH] add docstrings to API
docstrings will be our documentation. This is better
than a separate file, as it does not need to be edited separately
from the code.
---
zesje/api.py | 23 +++++++++++++++++++++++
1 file changed, 23 insertions(+)
diff --git a/zesje/api.py b/zesje/api.py
index 76a73936a..852b98a13 100644
--- a/zesje/api.py
+++ b/zesje/api.py
@@ -12,6 +12,16 @@ app = Blueprint(__name__, __name__)
@app.route('/graders', methods=['GET'])
@db.session
def get_graders():
+ """get all graders.
+
+
+ Returns
+ -------
+ list of:
+ id: int
+ first_name: str
+ last_name: str
+ """
return jsonify([
dict(id=g.id, first_name=g.first_name, last_name=g.last_name)
@@ -22,6 +32,19 @@ def get_graders():
@app.route('/graders', methods=['POST'])
@db.session
def post_graders():
+ """add a grader.
+
+ Parameters
+ ----------
+ first_name: str
+ last_name: str
+
+ Returns
+ -------
+ id: int
+ first_name: str
+ last_name: str
+ """
grader_spec = request.get_json(silent=False, force=True)
try:
new_grader = db.Grader(first_name=grader_spec['first_name'],
--
GitLab