change to use unbind schema instead of delete schema

linglp · linglp · commit 51ab0595ec23 · 2025-06-19T12:05:45.000-04:00
diff --git a/docs/reference/experimental/async/entityview.md b/docs/reference/experimental/async/entityview.md
@@ -27,7 +27,7 @@ at your own risk.
             - delete_permissions_async
             - bind_schema_async
             - get_schema_async
-            - delete_schema_async
+            - unbind_schema_async
             - validate_schema_async
             - get_schema_derived_keys_async
 ---
diff --git a/docs/reference/experimental/async/file.md b/docs/reference/experimental/async/file.md
@@ -24,7 +24,7 @@ at your own risk.
         - delete_permissions_async
         - bind_schema_async
         - get_schema_async
-        - delete_schema_async
+        - unbind_schema_async
         - validate_schema_async
         - get_schema_derived_keys_async
 ---
diff --git a/docs/reference/experimental/async/folder.md b/docs/reference/experimental/async/folder.md
@@ -21,6 +21,6 @@ at your own risk.
         - delete_permissions_async
         - bind_schema_async
         - get_schema_async
-        - delete_schema_async
+        - unbind_schema_async
         - validate_schema_async
         - get_schema_derived_keys_async
diff --git a/docs/reference/experimental/async/project.md b/docs/reference/experimental/async/project.md
@@ -20,6 +20,6 @@ at your own risk.
         - delete_permissions_async
         - bind_schema_async
         - get_schema_async
-        - delete_schema_async
+        - unbind_schema_async
         - validate_schema_async
         - get_schema_derived_keys_async
diff --git a/docs/reference/experimental/async/table.md b/docs/reference/experimental/async/table.md
@@ -29,7 +29,7 @@ at your own risk.
         - delete_permissions_async
         - bind_schema_async
         - get_schema_async
-        - delete_schema_async
+        - unbind_schema_async
         - validate_schema_async
         - get_schema_derived_keys_async
 
diff --git a/docs/reference/experimental/sync/entityview.md b/docs/reference/experimental/sync/entityview.md
@@ -27,7 +27,7 @@ at your own risk.
             - delete_permissions
             - bind_schema
             - get_schema
-            - delete_schema
+            - unbind_schema
             - validate_schema
             - get_schema_derived_keys
 ---
diff --git a/docs/reference/experimental/sync/file.md b/docs/reference/experimental/sync/file.md
@@ -34,7 +34,7 @@ at your own risk.
         - delete_permissions
         - bind_schema
         - get_schema
-        - delete_schema
+        - unbind_schema
         - validate_schema
         - get_schema_derived_keys
 ---
diff --git a/docs/reference/experimental/sync/folder.md b/docs/reference/experimental/sync/folder.md
@@ -32,6 +32,6 @@ at your own risk.
         - delete_permissions
         - bind_schema
         - get_schema
-        - delete_schema
+        - unbind_schema
         - validate_schema
         - get_schema_derived_keys
diff --git a/docs/reference/experimental/sync/project.md b/docs/reference/experimental/sync/project.md
@@ -31,6 +31,6 @@ at your own risk.
         - delete_permissions
         - bind_schema
         - get_schema
-        - delete_schema
+        - unbind_schema
         - validate_schema
         - get_schema_derived_keys
diff --git a/docs/reference/experimental/sync/table.md b/docs/reference/experimental/sync/table.md
@@ -39,7 +39,7 @@ at your own risk.
         - set_permissions
         - bind_schema
         - get_schema
-        - delete_schema
+        - unbind_schema
         - validate_schema
         - get_schema_derived_keys
 
diff --git a/synapseclient/models/mixins/json_schema.py b/synapseclient/models/mixins/json_schema.py
@@ -277,11 +277,11 @@ async def get_schema_async(
             enable_derived_annotations=response.get("enableDerivedAnnotations", None),
         )
 
-    async def delete_schema_async(
+    async def unbind_schema_async(
         self, *, synapse_client: Optional["Synapse"] = None
     ) -> None:
         """
-        Delete the JSON schema bound to the entity.
+        Unbind the JSON schema bound to the entity.
 
         Arguments:
             synapse_client (Optional[Synapse], optional): The Synapse client instance. If not provided,
diff --git a/synapseclient/models/protocols/json_schema_protocol.py b/synapseclient/models/protocols/json_schema_protocol.py
@@ -56,9 +56,9 @@ def get_schema(
         """
         return JSONSchemaBinding()
 
-    def delete_schema(self, *, synapse_client: Optional["Synapse"] = None) -> None:
+    def unbind_schema(self, *, synapse_client: Optional["Synapse"] = None) -> None:
         """
-        Delete the JSON schema bound to the entity.
+        Unbind the JSON schema from the entity.
 
         Arguments:
             synapse_client (Optional[Synapse], optional): The Synapse client instance. If not provided,
diff --git a/tests/integration/synapseclient/models/async/test_json_schema_async.py b/tests/integration/synapseclient/models/async/test_json_schema_async.py
@@ -169,7 +169,7 @@ async def test_bind_schema(
             assert json_schema_version_info.id == test_product_schema_uri
         finally:
             # Clean up the JSON schema binding
-            await created_entity.delete_schema_async(synapse_client=self.syn)
+            await created_entity.unbind_schema_async(synapse_client=self.syn)
 
     @pytest.mark.parametrize("entity_type", [Folder, Project, File, EntityView, Table])
     async def test_get_schema_async(
@@ -204,10 +204,10 @@ async def test_get_schema_async(
             assert response.json_schema_version_info.id == test_product_schema_uri
         finally:
             # Clean up the JSON schema binding
-            await created_entity.delete_schema_async(synapse_client=self.syn)
+            await created_entity.unbind_schema_async(synapse_client=self.syn)
 
     @pytest.mark.parametrize("entity_type", [Folder, Project, File, EntityView, Table])
-    async def test_delete_schema_async(
+    async def test_unbind_schema_async(
         self,
         entity_type: Type[Union[Folder, Project, File, EntityView, Table]],
         project_model: Project,
@@ -233,8 +233,8 @@ async def test_delete_schema_async(
             json_schema_uri=test_product_schema_uri, synapse_client=self.syn
         )
 
-        # Delete the JSON schema from the folder
-        await created_entity.delete_schema_async(synapse_client=self.syn)
+        # Unbind the JSON schema from the folder
+        await created_entity.unbind_schema_async(synapse_client=self.syn)
 
         # Verify that the JSON schema is no longer bound
         with pytest.raises(
@@ -297,7 +297,7 @@ async def test_get_schema_derived_keys_async(
             assert set(response.keys) == {"productId", "productName"}
         finally:
             # Clean up the JSON schema binding
-            await created_entity.delete_schema_async(synapse_client=self.syn)
+            await created_entity.unbind_schema_async(synapse_client=self.syn)
 
     @pytest.mark.parametrize("entity_type", [Folder, Project, File, EntityView, Table])
     async def test_validate_schema_async_invalid_annos(
@@ -356,7 +356,7 @@ async def test_validate_schema_async_invalid_annos(
             )
         finally:
             # Clean up the JSON schema binding
-            await created_entity.delete_schema_async(synapse_client=self.syn)
+            await created_entity.unbind_schema_async(synapse_client=self.syn)
 
     @pytest.mark.parametrize("entity_type", [Folder, Project, File, EntityView, Table])
     async def test_validate_schema_async_valid_annos(
@@ -400,7 +400,7 @@ async def test_validate_schema_async_valid_annos(
             assert response.is_valid == True
         finally:
             # Clean up the JSON schema binding
-            await created_entity.delete_schema_async(synapse_client=self.syn)
+            await created_entity.unbind_schema_async(synapse_client=self.syn)
 
     @pytest.mark.parametrize("entity_type", [Folder, Project])
     async def test_get_validation_statistics_async(
@@ -477,7 +477,7 @@ async def test_get_validation_statistics_async(
             assert response.number_of_invalid_children == 1
         finally:
             # Clean up the JSON schema binding
-            await created_entity.delete_schema_async(synapse_client=self.syn)
+            await created_entity.unbind_schema_async(synapse_client=self.syn)
 
     @pytest.mark.parametrize("entity_type", [Folder, Project])
     async def test_get_invalid_validation_async(
@@ -575,4 +575,4 @@ async def test_get_invalid_validation_async(
                 )
         finally:
             # Clean up the JSON schema binding
-            await created_entity.delete_schema_async(synapse_client=self.syn)
+            await created_entity.unbind_schema_async(synapse_client=self.syn)
diff --git a/tests/integration/synapseclient/models/synchronous/test_json_schema.py b/tests/integration/synapseclient/models/synchronous/test_json_schema.py
@@ -169,7 +169,7 @@ def test_bind_schema(
             assert json_schema_version_info.id == test_product_schema_uri
         finally:
             # Clean up the JSON schema binding
-            created_entity.delete_schema(synapse_client=self.syn)
+            created_entity.unbind_schema(synapse_client=self.syn)
 
     @pytest.mark.parametrize("entity_type", [Folder, Project, File, EntityView, Table])
     def test_get_schema(
@@ -204,10 +204,10 @@ def test_get_schema(
             assert response.json_schema_version_info.id == test_product_schema_uri
         finally:
             # Clean up the JSON schema binding
-            created_entity.delete_schema(synapse_client=self.syn)
+            created_entity.unbind_schema(synapse_client=self.syn)
 
     @pytest.mark.parametrize("entity_type", [Folder, Project, File, EntityView, Table])
-    def test_delete_schema(
+    def test_unbind_schema(
         self,
         entity_type: Type[Union[Folder, Project, File, EntityView, Table]],
         project_model: Project,
@@ -216,7 +216,7 @@ def test_delete_schema(
         entity_view: EntityView,
         create_test_organization_with_schema: Tuple[JsonSchemaOrganization, str],
     ) -> None:
-        """Test deleting a bound JSON schema from an entity."""
+        """Test unbinding a bound JSON schema from an entity."""
         # Create the folder
         created_entity = self.create_entity(
             entity_type,
@@ -233,8 +233,8 @@ def test_delete_schema(
             json_schema_uri=test_product_schema_uri, synapse_client=self.syn
         )
 
-        # Delete the JSON schema from the folder
-        created_entity.delete_schema(synapse_client=self.syn)
+        # Unbind the JSON schema from the folder
+        created_entity.unbind_schema(synapse_client=self.syn)
 
         # Verify that the JSON schema is no longer bound
         with pytest.raises(
@@ -295,7 +295,7 @@ def test_get_schema_derived_keys(
             assert set(response.keys) == {"productId", "productName"}
         finally:
             # Clean up the JSON schema binding
-            created_entity.delete_schema(synapse_client=self.syn)
+            created_entity.unbind_schema(synapse_client=self.syn)
 
     @pytest.mark.parametrize("entity_type", [Folder, Project, File, EntityView, Table])
     def test_validate_schema_invalid_annos(
@@ -352,7 +352,7 @@ def test_validate_schema_invalid_annos(
             )
         finally:
             # Clean up the JSON schema binding
-            created_entity.delete_schema(synapse_client=self.syn)
+            created_entity.unbind_schema(synapse_client=self.syn)
 
     @pytest.mark.parametrize("entity_type", [Folder, Project, File, EntityView, Table])
     def test_validate_schema_valid_annos(
@@ -394,7 +394,7 @@ def test_validate_schema_valid_annos(
             assert response.is_valid == True
         finally:
             # Clean up the JSON schema binding
-            created_entity.delete_schema(synapse_client=self.syn)
+            created_entity.unbind_schema(synapse_client=self.syn)
 
     @pytest.mark.parametrize("entity_type", [Folder, Project])
     def test_get_validation_statistics(
@@ -471,7 +471,7 @@ def test_get_validation_statistics(
             assert response.number_of_invalid_children == 1
         finally:
             # Clean up the JSON schema binding
-            created_entity.delete_schema(synapse_client=self.syn)
+            created_entity.unbind_schema(synapse_client=self.syn)
 
     @pytest.mark.parametrize("entity_type", [Folder, Project])
     def test_get_invalid_validation(
@@ -569,4 +569,4 @@ def test_get_invalid_validation(
                 )
         finally:
             # Clean up the JSON schema binding
-            created_entity.delete_schema(synapse_client=self.syn)
+            created_entity.unbind_schema(synapse_client=self.syn)
