Add deprecation warning to /group-privileges endpoint function.

1 files changed, 5 insertions, 0 deletions

diff --git a/gn_auth/auth/authorisation/resources/groups/views.py b/gn_auth/auth/authorisation/resources/groups/views.py
index f85809c..fb1a831 100644
--- a/gn_auth/auth/authorisation/resources/groups/views.py
+++ b/gn_auth/auth/authorisation/resources/groups/views.py
@@ -3,6 +3,7 @@ The views/routes for the `gn3.auth.authorisation.resources.groups` package.
 """
 import uuid
 import datetime
+import warnings
 from typing import Iterable
 from functools import partial
 from dataclasses import asdict
@@ -330,6 +331,10 @@ def group_privileges():
             return tuple(
                 privilege for arole in this_user_roles["roles"]
                 for privilege in arole.privileges) + group_level_roles #type: ignore[attr-defined]
+        warnings.warn(
+            (f"The `{__name__}.group_privileges` function is broken and will "
+             "be deleted."),
+            PendingDeprecationWarning)
         return jsonify(tuple(
             asdict(priv) for priv in with_db_connection(__list_privileges__)))