@watchers response includes watcher_properties which tells the frontend if a specific watcher is deleteable by the current user.

Author: elioschmutz

changes/TI-1935.other

@@ -0,0 +1 @@
+Extends the @watchers response with `watcher_properties` which tells the frontend if a specific watcher is deleteable by the current user. [elioschmutz]

docs/public/dev-manual/api/api_changelog.rst

@@ -24,6 +24,7 @@ Breaking Changes
 Other Changes
 ^^^^^^^^^^^^^
 ``@listing``: Filtering by inactive dossier responsible is now available.
+``@watchers``: Extends the @watchers response with ``watcher_properties``.
 
 2025.6.0 (2025-04-07)
 ---------------------

docs/public/dev-manual/api/watchers.rst

@@ -30,11 +30,11 @@ Ein Beobachter kann verschiedene Rollen haben, beispielsweise die Rollen Auftrag
         "referenced_actors": [
           {
             "@id": "https://example.org/@actors/peter.mueller",
-            "identifier": "peter.mueller",
+            "identifier": "peter.mueller"
           },
           {
             "@id": "https://example.org/@actors/rolf.ziegler",
-            "identifier": "rolf.ziegler",
+            "identifier": "rolf.ziegler"
           }
         ],
         "referenced_watcher_roles": [
@@ -49,7 +49,7 @@ Ein Beobachter kann verschiedene Rollen haben, beispielsweise die Rollen Auftrag
           {
             "id": "task_responsible",
             "title": "Auftragnehmer"
-          },
+          }
         ],
         "watchers_and_roles": {
           "peter.mueller": [
@@ -59,6 +59,14 @@ Ein Beobachter kann verschiedene Rollen haben, beispielsweise die Rollen Auftrag
             "regular_watcher",
             "task_responsible"
           ]
+        },
+        "watcher_properties": {
+          "peter.mueller": {
+            "can_delete_watcher": true
+          },
+          "rolf.ziegler": {
+            "can_delete_watcher": false
+          }
         }
       }
 
@@ -89,7 +97,8 @@ Die Beobachter können als Komponente eines Inhalts direkt über den ``expand``-
           "@id": "https://example.org/ordnungssystem/fuehrung/dossier-23/task-1/@listing-stats",
           "referenced_actors": ["..."],
           "referenced_watcher_roles": ["..."],
-          "watchers_and_roles": { "...": "..." }
+          "watchers_and_roles": { "...": "..." },
+          "watcher_properties": { "...": "..." }
         }
       },
       "...": "..."

opengever/api/tests/test_watchers.py

@@ -54,6 +54,10 @@ def test_get_watchers_for_tasks(self, browser):
             u'watchers_and_roles': {
                 self.regular_user.id: [u'regular_watcher', u'task_responsible'],
                 self.dossier_responsible.id: [u'task_issuer']
+            },
+            u'watcher_properties': {
+                self.regular_user.id: {'can_delete_watcher': True },
+                self.dossier_responsible.id: {'can_delete_watcher': False },
             }
         }
 
@@ -106,6 +110,10 @@ def test_get_watchers_for_inbox_forwarding(self, browser):
             u'watchers_and_roles': {
                 self.regular_user.id: [u'regular_watcher', u'task_responsible'],
                 self.dossier_responsible.id: [u'task_issuer']
+            },
+            u'watcher_properties': {
+                self.regular_user.id: {'can_delete_watcher': False },
+                self.dossier_responsible.id: {'can_delete_watcher': False },
             }
         }
 
@@ -143,6 +151,9 @@ def test_get_watchers_for_documents(self, browser):
             ],
             u'watchers_and_roles': {
                 self.dossier_responsible.id: [u'regular_watcher']
+            },
+            u'watcher_properties': {
+                self.dossier_responsible.id: {'can_delete_watcher': False },
             }
         }
 
@@ -179,6 +190,9 @@ def test_get_watchers_for_mails(self, browser):
             ],
             u'watchers_and_roles': {
                 self.dossier_responsible.id: [u'regular_watcher']
+            },
+            u'watcher_properties': {
+                self.dossier_responsible.id: {'can_delete_watcher': False },
             }
         }
 
@@ -219,6 +233,9 @@ def test_watchers_endpoint_supports_teams(self, browser):
             ],
             u'watchers_and_roles': {
                 u'team:1': [u'task_responsible'],
+            },
+            u'watcher_properties': {
+                u'team:1': {'can_delete_watcher': False },
             }
         }
 
@@ -257,9 +274,11 @@ def test_watchers_endpoint_supports_inboxes(self, browser):
             ],
             u'watchers_and_roles': {
                 u'inbox:fa': [u'task_responsible'],
+            },
+            u'watcher_properties': {
+                u'inbox:fa': {'can_delete_watcher': False },
             }
         }
-
         self.assertEqual(expected_json, browser.json)
 
         browser.open(self.task.absolute_url() + '?expand=watchers',
@@ -289,7 +308,8 @@ def test_get_watchers_hides_inactive_users(self, browser):
         expected_json = {u'@id': self.document.absolute_url() + '/@watchers',
                          u'referenced_actors': [],
                          u'referenced_watcher_roles': [],
-                         u'watchers_and_roles': {}}
+                         u'watchers_and_roles': {},
+                         u'watcher_properties': {}}
         self.assertEqual(expected_json, browser.json['@components']['watchers'])
 
 

opengever/api/watchers.py

@@ -59,9 +59,15 @@ def __call__(self, expand=False):
             }
             for role in roles]
 
+        watcher_properties = defaultdict(dict)
+        deleter = WatcherDeleter(self.context)
+        for actor_id in watchers_and_roles:
+            watcher_properties[actor_id]['can_delete_watcher'] = deleter.can_delete(actor_id)
+
         result['watchers']['watchers_and_roles'] = watchers_and_roles
         result['watchers']['referenced_watcher_roles'] = referenced_watcher_roles
         result['watchers']['referenced_actors'] = referenced_actors
+        result['watchers']['watcher_properties'] = watcher_properties
         return result