refactor: change terminology from 'plugin' to 'mechanism' #350

- This just keeps the terminology in line with what we use in DataGateway API and more generally within ICAT
ral-facilities · Mar 29, 2022 · 4a92ac0 · 4a92ac0
1 parent 78d76c1
commit 4a92ac0
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/datagateway_api/config.json.example b/datagateway_api/config.json.example
@@ -13,7 +13,7 @@
         "extension": "/search-api",
         "icat_url": "https://localhost:8181",
         "icat_check_cert": false,
-        "plugin": "anon",
+        "mechanism": "anon",
         "username": "",
         "password": ""
     },

diff --git a/datagateway_api/src/common/config.py b/datagateway_api/src/common/config.py
@@ -130,7 +130,7 @@ class SearchAPI(BaseModel):
     extension: StrictStr
     icat_check_cert: StrictBool
     icat_url: StrictStr
-    plugin: StrictStr
+    mechanism: StrictStr
     username: StrictStr
     password: StrictStr
 

diff --git a/datagateway_api/src/search_api/session_handler.py b/datagateway_api/src/search_api/session_handler.py
@@ -35,7 +35,7 @@ def wrapper_client_manager(*args, **kwargs):
         except ICATSessionError as e:
             log.debug("Current client session expired: %s", e.args)
             SessionHandler.client.login(
-                Config.config.search_api.plugin,
+                Config.config.search_api.mechanism,
                 {
                     "username": Config.config.search_api.username,
                     "password": Config.config.search_api.password,