Browse Source

better docstring for workspace role decorator

Guénaël Muller 6 years ago
parent
commit
50d4e27065
1 changed files with 4 additions and 4 deletions
  1. 4 4
      tracim/lib/utils/authorization.py

+ 4 - 4
tracim/lib/utils/authorization.py View File

@@ -83,8 +83,8 @@ def require_profile(group: int):
83 83
 
84 84
 def require_workspace_role(minimal_required_role: int):
85 85
     """
86
-    Decorator for view to restrict access of tracim request if role
87
-    is not high enough
86
+    Restricts access to endpoint to minimal role or raise an exception.
87
+    Check role for current_workspace.
88 88
     :param minimal_required_role: value from UserInWorkspace Object like
89 89
     UserRoleInWorkspace.CONTRIBUTOR or UserRoleInWorkspace.READER
90 90
     :return: decorator
@@ -104,8 +104,8 @@ def require_workspace_role(minimal_required_role: int):
104 104
 
105 105
 def require_candidate_workspace_role(minimal_required_role: int):
106 106
     """
107
-    Decorator for view to restrict access of tracim request if role
108
-    is not high enough.
107
+    Restricts access to endpoint to minimal role or raise an exception.
108
+    Check role for candidate_workspace.
109 109
     :param minimal_required_role: value from UserInWorkspace Object like
110 110
     UserRoleInWorkspace.CONTRIBUTOR or UserRoleInWorkspace.READER
111 111
     :return: decorator