From 88a6fe43b6e0067b60d871a22cff40e197ab98ac Mon Sep 17 00:00:00 2001 From: John Nduli Date: Thu, 29 Aug 2024 10:58:43 +0300 Subject: docs: add function comments --- gn3/api/metadata_api/wiki.py | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) (limited to 'gn3/api') diff --git a/gn3/api/metadata_api/wiki.py b/gn3/api/metadata_api/wiki.py index 32872f3..a4abef6 100644 --- a/gn3/api/metadata_api/wiki.py +++ b/gn3/api/metadata_api/wiki.py @@ -89,24 +89,31 @@ def get_wiki_entries(symbol: str): @wiki_blueprint.route("/", methods=["GET"]) def get_wiki(comment_id: int): + """ + Gets latest wiki comments. + + TODO: fetch this from RIF + """ with db_utils.database_connection(current_app.config["SQL_URI"]) as conn: return jsonify(wiki.get_latest_comment(conn, comment_id)) - return jsonify(error="Error editting wiki entry, most likely due to DB error!"), 500 + return jsonify(error="Error fetching wiki entry, most likely due to DB error!"), 500 @wiki_blueprint.route("/categories", methods=["GET"]) def get_categories(): + """ Gets list of supported categories for RIF """ with db_utils.database_connection(current_app.config["SQL_URI"]) as conn: cursor = conn.cursor() categories_dict = wiki.get_categories(cursor) return jsonify(categories_dict) - return jsonify(error="Error editting wiki entry, most likely due to DB error!"), 500 + return jsonify(error="Error getting categories, most likely due to DB error!"), 500 @wiki_blueprint.route("/species", methods=["GET"]) def get_species(): + """ Gets list of all species, contains name and SpeciesName """ with db_utils.database_connection(current_app.config["SQL_URI"]) as conn: cursor = conn.cursor() species_dict = wiki.get_species(cursor) return jsonify(species_dict) - return jsonify(error="Error editting wiki entry, most likely due to DB error!"), 500 + return jsonify(error="Error getting species, most likely due to DB error!"), 500 -- cgit v1.2.3