add swagger header (#877)

* add swagger header * edit links in template
bloomberg · Oct 13, 2023 · dc4e90b · dc4e90b
1 parent 0223276
commit dc4e90b
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 6 deletions.
diff --git a/pybossa/core.py b/pybossa/core.py
@@ -47,10 +47,6 @@ def create_app(run_as_server=True):
 
     setup_logging(run_as_server)
     app = Flask(__name__.split('.')[0])
-    app.config['SWAGGER'] = {
-        'title': 'GIGwork API',
-    }
-    swag  = Swagger(app)
     configure_app(app)
     global talisman
     talisman = Talisman(app, content_security_policy={
@@ -100,7 +96,7 @@ def create_app(run_as_server=True):
     anonymizer.init_app(app)
     setup_task_presenter_editor(app)
     setup_schedulers(app)
-
+    Swagger(app, template=app.config.get('SWAGGER_TEMPLATE'))
     return app
 
 # construct rq_dashboard config

diff --git a/pybossa/settings_local.py.tmpl b/pybossa/settings_local.py.tmpl
@@ -526,4 +526,11 @@ USAGE_DASHBOARD_COMPONENTS = {
     'Multiselect Input' : 'multi-select-input',
     'Table' : 'table-element',
     'Input Text Area' : 'input-text-area'
-}
+}
+
+SWAGGER_TEMPLATE = {
+    'info': {
+        'title': 'Local GIGwork API',
+        'description': 'Explore and experiment with Gigwork\'s REST APIs.\nUseful Links:\n- [Pybossa Docs](https://docs.pybossa.com/)',
+    },
+}
diff --git a/settings_test.py.tmpl b/settings_test.py.tmpl
@@ -255,3 +255,10 @@ COMPLETED_TASK_CLEANUP_DAYS = [
 MAX_IMAGE_UPLOAD_SIZE_MB = 5
 
 MAX_SAVED_ANSWERS = 1
+
+SWAGGER_TEMPLATE = {
+    'info': {
+        'title': 'Local GIGwork API',
+        'description': 'Explore and experiment with Gigwork\'s REST APIs.\nUseful Links:\n- [Pybossa Docs](https://docs.pybossa.com/)',
+    },
+}