Skip to content

Commit e1b00bf

Browse files
committed
Update tutorial prerequisites and clarify permission management details
1 parent e573412 commit e1b00bf

File tree

3 files changed

+5
-1
lines changed

3 files changed

+5
-1
lines changed

docs/explanations/access_control.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ Synapse supports several permission types that can be combined:
2929
- **CHANGE_SETTINGS**: Modify entity settings
3030
- **MODERATE**: Moderate forum discussions (for projects)
3131

32+
Other synapse items like `Submission` and `Evaluation` support different permission types not covered in this document.
33+
3234
### Special Principal IDs
3335
Synapse provides special principals for common sharing scenarios:
3436

docs/tutorials/python/sharing_settings.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ In this tutorial you will:
2222
## Prerequisites
2323
* Make sure that you have completed the [Installation](../installation.md) and [Authentication](../authentication.md) setup.
2424
* **IMPORTANT**: You must set a valid `PRINCIPAL_ID` in the tutorial script before running it. This should be a Synapse user ID or team ID that you want to grant permissions to.
25+
* You must have a [Project](./project.md) created and replace the one used in this tutorial.
2526

2627
## Understanding Permission Types
2728

@@ -56,12 +57,14 @@ Every entity in Synapse has a **benefactor** - the entity from which it inherits
5657
4. **Inherit permissions**: The entity inherits all permissions from its benefactor
5758

5859
### Default Inheritance Behavior
60+
5961
- **New Projects**: Become their own benefactor with default permissions
6062
- **New Folders/Files**: Initially inherit from their containing Project or parent Folder
6163
- **Local ACLs**: When you set local sharing settings, the entity becomes its own benefactor
6264

6365
### Applying Permissions to Other Entities
6466
While this tutorial focuses on Folders, you can apply the same permission management methods (`get_permissions()`, `get_acl()`, `set_permissions()`, `list_acl()`, and `delete_permissions()`) to other Synapse entities including:
67+
6568
- **Projects**: Top-level containers that are typically their own benefactors
6669
- **Files**: Individual data files that can have their own sharing settings
6770
- **Tables**: Structured data entities with their own permission requirements

synapseclient/models/mixins/access_control.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -776,7 +776,6 @@ async def _process_folder_permission_deletion(
776776
benefactor_tracker: Tracker for managing benefactor relationships.
777777
Only used for non-recursive processing.
778778
target_entity_types: A list of normalized entity types to process.
779-
For non-recursive processing, defaults to ["folder"].
780779
progress_bar: Optional progress bar to update as tasks complete.
781780
include_container_content: Whether to include the content of containers in processing.
782781
Only used for recursive processing.

0 commit comments

Comments
 (0)