Skip to content

[SYNPY-1702] Update curator extensions related documentation #1312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thomasyu888 merged 3 commits into from
Jan 29, 2026
Merged

[SYNPY-1702] Update curator extensions related documentation #1312

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
442f2ca
[SYNPY-1702] Clarify folder_id comment in metadata_curation.md
thomasyu888 Jan 29, 2026
4a89bc5
Change this to False
thomasyu888 Jan 29, 2026
0508748
Update documentation
thomasyu888 Jan 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/guides/extensions/curator/metadata_curation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Use this when metadata describes individual data files and is stored as annotati
record_set, curation_task, data_grid = create_record_based_metadata_task(
synapse_client=syn,
project_id="syn123456789", # Your project ID
folder_id="syn987654321", # Folder where files are stored
folder_id="syn987654321", # Folder where RecordSet Entity will be stored
record_set_name="AnimalMetadata_Records",
record_set_description="Centralized metadata for animal study data",
curation_task_name="AnimalMetadata_Curation", # Must be unique within the project
Expand Down Expand Up @@ -104,7 +104,7 @@ entity_view_id, task_id = create_file_based_metadata_task(
folder_id="syn987654321", # Folder containing your data files
curation_task_name="FileMetadata_Curation", # Must be unique within the project
instructions="Annotate each file with metadata according to the schema requirements.",
attach_wiki=True, # Creates a wiki in the folder with the entity view (Defaults to False)
attach_wiki=False, # Creates a wiki in the folder with the entity view (Defaults to False)
entity_view_name="Animal Study Files View",
schema_uri=schema_uri # Schema found in Step 2
)
Expand Down
2 changes: 1 addition & 1 deletion synapseclient/extensions/curator/record_based_metadata_task.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ def create_record_based_metadata_task(

Arguments:
project_id: The Synapse ID of the project where the folder exists.
folder_id: The Synapse ID of the folder to upload to.
folder_id: The Synapse ID of the folder to upload RecordSet to.
record_set_name: Name for the RecordSet.
record_set_description: Description for the RecordSet.
curation_task_name: Name for the CurationTask (used as data_type field).
Expand Down
Loading