Added docstring

department-of-veterans-affairs · Dec 2, 2024 · 946f37b · 946f37b
1 parent 37f5a67
commit 946f37b
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/notifications_utils/logging.py b/notifications_utils/logging.py
@@ -160,5 +160,9 @@ def filter(self, record):
         return record
 
     @classmethod
-    def _get_api_id(self):
-        return g.request_id if getattr(g, 'request_id', '') else str(uuid4()).replace('-', '')
+    def _get_api_id(self) -> str:
+        """Generate a request_id.
+
+        g is a global for this request. It is attached to the Flask and is only persisted for that request.
+        """
+        return g.request_id if getattr(g, 'request_id', '') else str(uuid4())