change to use enable_derived_annotations

Author: linglp

docs/tutorials/python/json_schema.md

@@ -50,7 +50,7 @@ Note: If you update your schema, you can re-register it with the organization an
 ## 4. Bind the JSON Schema to the Folder
 After creating the organization, you can now bind your json schema to a test folder. When you bind a JSON Schema to a container entity such as a project or folder, then all items inside of the project or folder will inherit the schema binding, unless the item has a schema bound to itself.
 
-When you bind the schema, you may also include the boolean property `enable_derived_annos` to have Synapse automatically calculate derived annotations based on the schema:
+When you bind the schema, you may also include the boolean property `enable_derived_annotations` to have Synapse automatically calculate derived annotations based on the schema:
 
 ```python
 {!docs/tutorials/python/tutorial_scripts/json_schema.py!lines=93-100}

docs/tutorials/python/tutorial_scripts/json_schema.py

@@ -92,7 +92,7 @@
 # 4. Bind the JSON schema to the folder
 schema_uri = ORG_NAME + "-" + SCHEMA_NAME + "-" + VERSION
 bound_schema = test_folder.bind_schema(
-    json_schema_uri=schema_uri, enable_derived_annos=True
+    json_schema_uri=schema_uri, enable_derived_annotations=True
 )
 json_schema_version_info = bound_schema.json_schema_version_info
 print("JSON schema was bound successfully. Please see details below:")

synapseclient/api/json_schema_services.py

@@ -20,7 +20,7 @@ async def bind_json_schema_to_entity(
     synapse_id: str,
     json_schema_uri: str,
     *,
-    enable_derived_annos: bool = False,
+    enable_derived_annotations: bool = False,
     synapse_client: Optional["Synapse"] = None,
 ) -> Union[Dict[str, Any], str]:
     """
@@ -31,7 +31,7 @@ async def bind_json_schema_to_entity(
     Arguments:
         synapse_id:      Synapse Entity or Synapse Id
         json_schema_uri: JSON schema URI
-        enable_derived_annos:  If True, derived annotations will be enabled for this entity
+        enable_derived_annotations:  If True, derived annotations will be enabled for this entity
         synapse_client:  If not passed in and caching was not disabled by
                          `Synapse.allow_client_caching(False)` this will use the last created
                          instance from the Synapse class constructor
@@ -44,7 +44,7 @@ async def bind_json_schema_to_entity(
     request_body = {
         "entityId": synapse_id,
         "schema$id": json_schema_uri,
-        "enableDerivedAnnotations": enable_derived_annos,
+        "enableDerivedAnnotations": enable_derived_annotations,
     }
     return await client.rest_put_async(
         uri=f"/entity/{synapse_id}/schema/binding", body=json.dumps(request_body)

synapseclient/models/mixins/json_schema.py

@@ -196,15 +196,15 @@ async def bind_schema_async(
         self,
         json_schema_uri: str,
         *,
-        enable_derived_annos: bool = False,
+        enable_derived_annotations: bool = False,
         synapse_client: Optional["Synapse"] = None,
     ) -> JSONSchemaBinding:
         """
         Bind a JSON schema to the entity.
 
         Arguments:
             json_schema_uri: The URI of the JSON schema to bind to the entity.
-            enable_derived_annos: If true, enable derived annotations. Defaults to False.
+            enable_derived_annotations: If true, enable derived annotations. Defaults to False.
             synapse_client: The Synapse client instance. If not provided,
                 the last created instance from the Synapse class constructor will be used.
 
@@ -264,7 +264,7 @@ async def bind_schema_async(
                 async def bind_json_schema():
                     bound_schema = await test_folder.bind_schema_async(
                         json_schema_uri=SCHEMA_URI,
-                        enable_derived_annos=True
+                        enable_derived_annotations=True
                     )
                     return bound_schema
                 asyncio.run(bind_json_schema())
@@ -278,7 +278,7 @@ async def bind_json_schema():
                 async def bind_schema_to_file():
                     bound_schema_file = await example_file.bind_schema_async(
                         json_schema_uri=SCHEMA_URI,
-                        enable_derived_annos=True
+                        enable_derived_annotations=True
                     )
                     return bound_schema_file
                 asyncio.run(bind_schema_to_file())
@@ -287,7 +287,7 @@ async def bind_schema_to_file():
         response = await bind_json_schema_to_entity(
             synapse_id=self.id,
             json_schema_uri=json_schema_uri,
-            enable_derived_annos=enable_derived_annos,
+            enable_derived_annotations=enable_derived_annotations,
             synapse_client=synapse_client,
         )
         json_schema_version = response.get("jsonSchemaVersionInfo", {})
@@ -377,7 +377,7 @@ async def get_schema_async(
                 async def bind_json_schema():
                     bound_schema = await test_folder.bind_schema_async(
                         json_schema_uri=SCHEMA_URI,
-                        enable_derived_annos=True
+                        enable_derived_annotations=True
                     )
                     return bound_schema
                 asyncio.run(bind_json_schema())
@@ -391,7 +391,7 @@ async def bind_json_schema():
                 async def bind_schema_to_file():
                     bound_schema_file = await example_file.bind_schema_async(
                         json_schema_uri=SCHEMA_URI,
-                        enable_derived_annos=True
+                        enable_derived_annotations=True
                     )
                     return bound_schema_file
                 asyncio.run(bind_schema_to_file())
@@ -500,7 +500,7 @@ async def unbind_schema_async(
                 async def bind_json_schema():
                     bound_schema = await test_folder.bind_schema_async(
                         json_schema_uri=SCHEMA_URI,
-                        enable_derived_annos=True
+                        enable_derived_annotations=True
                     )
                     return bound_schema
                 asyncio.run(bind_json_schema())
@@ -514,7 +514,7 @@ async def bind_json_schema():
                 async def bind_schema_to_file():
                     bound_schema_file = await example_file.bind_schema_async(
                         json_schema_uri=SCHEMA_URI,
-                        enable_derived_annos=True
+                        enable_derived_annotations=True
                     )
                     return bound_schema_file
                 asyncio.run(bind_schema_to_file())
@@ -602,7 +602,7 @@ async def validate_schema_async(
                 async def bind_json_schema():
                     bound_schema = await test_folder.bind_schema_async(
                         json_schema_uri=SCHEMA_URI,
-                        enable_derived_annos=True
+                        enable_derived_annotations=True
                     )
                     return bound_schema
                 asyncio.run(bind_json_schema())
@@ -616,7 +616,7 @@ async def bind_json_schema():
                 async def bind_schema_to_file():
                     bound_schema_file = await example_file.bind_schema_async(
                         json_schema_uri=SCHEMA_URI,
-                        enable_derived_annos=True
+                        enable_derived_annotations=True
                     )
                     return bound_schema_file
                 asyncio.run(bind_schema_to_file())
@@ -768,7 +768,7 @@ async def get_schema_derived_keys_async(
                 async def bind_json_schema():
                     bound_schema = await test_folder.bind_schema_async(
                         json_schema_uri=SCHEMA_URI,
-                        enable_derived_annos=True
+                        enable_derived_annotations=True
                     )
                     return bound_schema
                 asyncio.run(bind_json_schema())
@@ -782,7 +782,7 @@ async def bind_json_schema():
                 async def bind_schema_to_file():
                     bound_schema_file = await example_file.bind_schema_async(
                         json_schema_uri=SCHEMA_URI,
-                        enable_derived_annos=True
+                        enable_derived_annotations=True
                     )
                     return bound_schema_file
                 asyncio.run(bind_schema_to_file())
@@ -887,7 +887,7 @@ async def get_schema_validation_statistics_async(
                 async def bind_json_schema():
                     bound_schema = await test_folder.bind_schema_async(
                         json_schema_uri=SCHEMA_URI,
-                        enable_derived_annos=True
+                        enable_derived_annotations=True
                     )
                     return bound_schema
                 asyncio.run(bind_json_schema())
@@ -984,7 +984,7 @@ async def get_invalid_validation_async(
                 async def bind_json_schema():
                     bound_schema = await test_folder.bind_schema_async(
                         json_schema_uri=SCHEMA_URI,
-                        enable_derived_annos=True
+                        enable_derived_annotations=True
                     )
                     return bound_schema
                 asyncio.run(bind_json_schema())
@@ -1115,7 +1115,7 @@ def get_invalid_validation(
                 async def bind_json_schema():
                     bound_schema = await test_folder.bind_schema_async(
                         json_schema_uri=SCHEMA_URI,
-                        enable_derived_annos=True
+                        enable_derived_annotations=True
                     )
                     return bound_schema
                 asyncio.run(bind_json_schema())

synapseclient/models/protocols/json_schema_protocol.py

@@ -24,15 +24,15 @@ def bind_schema(
         self,
         json_schema_uri: str,
         *,
-        enable_derived_annos: bool = False,
+        enable_derived_annotations: Optional[bool] = False,
         synapse_client: Optional["Synapse"] = None,
     ) -> "JSONSchemaBinding":
         """
         Bind a JSON schema to the entity.
 
         Arguments:
             json_schema_uri (str): The URI of the JSON schema to bind to the entity.
-            enable_derived_annos (bool, optional): If true, enable derived annotations. Defaults to False.
+            enable_derived_annotations (bool, optional): If true, enable derived annotations. Defaults to False.
             synapse_client (Optional[Synapse], optional): The Synapse client instance. If not provided,
                 the last created instance from the Synapse class constructor will be used.
 

tests/integration/synapseclient/models/async/test_json_schema_async.py

@@ -271,7 +271,7 @@ async def test_get_schema_derived_keys_async(
         try:
             await created_entity.bind_schema_async(
                 json_schema_uri=test_product_schema_uri,
-                enable_derived_annos=True,
+                enable_derived_annotations=True,
                 synapse_client=self.syn,
             )
 

tests/integration/synapseclient/models/synchronous/test_json_schema.py

@@ -271,7 +271,7 @@ def test_get_schema_derived_keys(
         try:
             created_entity.bind_schema(
                 json_schema_uri=test_product_schema_uri,
-                enable_derived_annos=True,
+                enable_derived_annotations=True,
                 synapse_client=self.syn,
             )