Update compass.py

Small enhancements to the documentation for compass.api_update_resource_roles with a payload example for patch_grants
emdgroup · Sep 27, 2024 · 7721542 · 7721542
1 parent 0cf3edf
commit 7721542
Showing 1 changed file with 12 additions and 1 deletion.
diff --git a/libs/foundry-dev-tools/src/foundry_dev_tools/clients/compass.py b/libs/foundry-dev-tools/src/foundry_dev_tools/clients/compass.py
@@ -1093,7 +1093,18 @@ def api_update_resource_roles(
 
         Args:
             rid: resource identifier, for the resource for which roles will be updated
-            grant_patches: the role grants that should be patched
+            grant_patches: list of role grants that should be patched.
+                grant_patches have the following structure
+                [{
+                    "patchOperation": "ADD" | "REMOVE",
+                    "roleGrant": {
+                        "role": roleset_id,
+                        "principal": {
+                            "id": multipass_id,
+                            "type": "USER" | "GROUP" | "EVERYONE"
+                        }
+                    }
+                }]
             disable_inherited_permissions_for_principals: patch role grants for the provided inherited permissions
             disable_inherited_permissions: disable inherited permissions
             **kwargs: gets passed to :py:meth:`APIClient.api_request`