Change default behavior of file based metadata tasks to not attach wikis (#1270)

* update tests for new default behavior

* change default wiki behavior

* update documentation

Author: SageGJ

docs/guides/extensions/curator/metadata_curation.md

@@ -103,7 +103,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
+    attach_wiki=True,                  # 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
 )

synapseclient/extensions/curator/file_based_metadata_task.py

@@ -294,7 +294,7 @@ def create_file_based_metadata_task(
     folder_id: str,
     curation_task_name: str,
     instructions: str,
-    attach_wiki: bool = True,
+    attach_wiki: bool = False,
     entity_view_name: str = "JSON Schema view",
     schema_uri: Optional[str] = None,
     enable_derived_annotations: bool = False,
@@ -320,7 +320,7 @@ def create_file_based_metadata_task(
             folder_id="syn12345678",
             curation_task_name="BiospecimenMetadataTemplate",
             instructions="Please curate this metadata according to the schema requirements",
-            attach_wiki=True,
+            attach_wiki=False,
             entity_view_name="Biospecimen Metadata View",
             schema_uri="sage.schemas.v2571-amp.Biospecimen.schema-0.0.1"
         )
@@ -332,7 +332,7 @@ def create_file_based_metadata_task(
             Must be unique within the project, otherwise if it matches an existing
             CurationTask, that task will be updated with new data.
         instructions: Instructions for the curation task.
-        attach_wiki: Whether or not to attach a Synapse Wiki (default: True).
+        attach_wiki: Whether or not to attach a Synapse Wiki (default: False).
         entity_view_name: Name for the created entity view (default: "JSON Schema view").
         schema_uri: Optional JSON schema URI to bind to the folder. If provided,
             the schema will be bound to the folder before creating the entity view.

tests/unit/synapseclient/extensions/unit_test_curator.py

@@ -206,6 +206,7 @@ def test_create_file_based_metadata_task_missing_folder_id(self, mock_get_client
                 folder_id="",
                 curation_task_name=self.curation_task_name,
                 instructions=self.instructions,
+                attach_wiki=True,
                 synapse_client=self.mock_syn,
             )
 
@@ -226,6 +227,7 @@ def test_create_file_based_metadata_task_missing_curation_task_name(
                 folder_id=self.folder_id,
                 curation_task_name="",
                 instructions=self.instructions,
+                attach_wiki=True,
                 synapse_client=self.mock_syn,
             )
 
@@ -246,6 +248,7 @@ def test_create_file_based_metadata_task_missing_instructions(
                 folder_id=self.folder_id,
                 curation_task_name=self.curation_task_name,
                 instructions="",
+                attach_wiki=True,
                 synapse_client=self.mock_syn,
             )
 
@@ -272,6 +275,7 @@ def test_create_file_based_metadata_task_schema_binding_error(
                 folder_id=self.folder_id,
                 curation_task_name=self.curation_task_name,
                 instructions=self.instructions,
+                attach_wiki=True,
                 schema_uri=self.schema_uri,
                 synapse_client=self.mock_syn,
             )
@@ -302,6 +306,7 @@ def test_create_file_based_metadata_task_entity_view_creation_error(
                 folder_id=self.folder_id,
                 curation_task_name=self.curation_task_name,
                 instructions=self.instructions,
+                attach_wiki=True,
                 synapse_client=self.mock_syn,
             )