From 12aaae05f7bf657805e8a3ca939d3de6ef3fdcae Mon Sep 17 00:00:00 2001 From: Alexandre Dulaunoy Date: Sat, 22 May 2021 12:55:46 +0200 Subject: [PATCH] chg: [api] add documentation to default endpoints --- backend/bin/server.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/backend/bin/server.py b/backend/bin/server.py index 29e1841..8f6d9a1 100644 --- a/backend/bin/server.py +++ b/backend/bin/server.py @@ -4,7 +4,7 @@ from flask_restx import Resource, Api app = Flask(__name__) app.url_map.strict_slashes = False -api = Api(app, version=version, title='CyCAT.org API', description='CyberSecurity catalog API services', doc='/doc/') +api = Api(app, version=version, title='CyCAT.org API', description='CyCAT - The Cybersecurity Resource Catalogue public API services.', doc='/doc/') import uuid import inspect import redis @@ -12,11 +12,13 @@ import redis r = redis.Redis(host='127.0.0.1', port='3033') @api.route('/info') +@api.doc(description="Get information about the CyCAT backend services including status, overall statistics and version.") class info(Resource): def get(self): return "CyCAT backend {}".format(version) @api.route('/generate/uuid') +@api.doc(description="Generate an UUID version 4 RFC4122-compliant.") class generateUUID(Resource): def get(self): genuuid = uuid.uuid4()