Merge pull request #331 from osmith42/api-service-redirect

services/apiService: redirect from / to /docs

Author: osmith42

services/apiService.py

@@ -7,7 +7,7 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 import sys
 import json
-from flask import Flask, request, jsonify, Response
+from flask import Flask, request, jsonify, Response, redirect
 from flask_restx import Api, Resource, fields, reqparse, abort
 from werkzeug.middleware.proxy_fix import ProxyFix
 from functools import wraps
@@ -63,6 +63,10 @@
 
 apiService = Flask(__name__)
 
+@apiService.route("/")
+def PyHSS_API_redirect_to_docs():
+    return redirect("/docs/")
+
 APN = database.APN
 Serving_APN = database.SERVING_APN
 AUC = database.AUC
@@ -258,7 +262,12 @@ def decorated_function(*args, **kwargs):
     return decorated_function
 
 def auth_before_request():
-    if request.path.startswith('/docs') or request.path.startswith('/swagger') or request.path.startswith('/metrics'):
+    if (
+        request.path.startswith("/docs")
+        or request.path.startswith("/swagger")
+        or request.path.startswith("/metrics")
+        or request.path == "/"
+    ):
         return None
     if request.method == "OPTIONS":
         res = Response()