Adds derivation type unspecified and exposes derivation_type for get_entity_derivations (#123)

* Adds derivation type unspecified. 
* Exposes derivation_type for get_entity_derivations

Author: juanjosegarcan

src/entitysdk/_server_schemas.py

@@ -213,6 +213,7 @@ class ContributionCreate(BaseModel):
 class DerivationType(StrEnum):
     circuit_extraction = "circuit_extraction"
     circuit_rewiring = "circuit_rewiring"
+    unspecified = "unspecified"
 
 
 class DetailedFile(BaseModel):

src/entitysdk/client.py

@@ -27,6 +27,7 @@
     AssetLabel,
     ContentType,
     DeploymentEnvironment,
+    DerivationType,
     StorageType,
     Token,
 )
@@ -169,14 +170,15 @@ def get_entity_derivations(
         *,
         entity_id: ID,
         entity_type: type[Entity],
+        derivation_type: DerivationType,
         project_context: ProjectContext | None = None,
     ) -> IteratorResult[Entity]:
         """Get all the derivation for an entity."""
         return core.get_entity_derivations(
             api_url=self.api_url,
             entity_id=entity_id,
             entity_type=entity_type,
-            derivation_type=None,
+            derivation_type=derivation_type,
             project_context=self._required_user_context(override_context=project_context),
             token=self._token_manager.get_token(),
         )

src/entitysdk/core.py

@@ -95,7 +95,7 @@ def get_entity_derivations(
     entity_id: ID,
     entity_type: type[Entity],
     project_context: ProjectContext,
-    derivation_type: DerivationType | None,
+    derivation_type: DerivationType,
     token: str,
     http_client: httpx.Client | None = None,
 ) -> IteratorResult[Entity]:
@@ -106,7 +106,7 @@ def get_entity_derivations(
         entity_id=entity_id,
     )
 
-    params = {"derivation_type": DerivationType(derivation_type)} if derivation_type else None
+    params = {"derivation_type": DerivationType(derivation_type)}
 
     response = make_db_api_request(
         url=url,

tests/unit/test_client.py

@@ -1121,30 +1121,48 @@ def test_client_get_entity_derivations(mock_route, client, httpx_mock, api_url,
     used_id = uuid.uuid4()
     generated_id = uuid.uuid4()
 
-    httpx_mock.add_response(
-        method="GET",
-        url=f"{api_url}/circuit/{entity_id}/derived-from",
-        match_headers=request_headers,
-        json={
-            "data": [
-                {
-                    "id": str(derivation_1),
-                    "used_id": str(used_id),
-                    "generated_id": str(generated_id),
-                },
-                {
-                    "id": str(derivation_2),
-                    "used_id": str(used_id),
-                    "generated_id": str(generated_id),
-                    "derivation_type": DerivationType.circuit_extraction,
-                },
-            ]
-        },
-    )
+    def add_response(derivation_type: DerivationType):
+        httpx_mock.add_response(
+            method="GET",
+            url=f"{api_url}/circuit/{entity_id}/derived-from?derivation_type={derivation_type}",
+            match_headers=request_headers,
+            json={
+                "data": [
+                    {
+                        "id": str(derivation_1),
+                        "used_id": str(used_id),
+                        "generated_id": str(generated_id),
+                        "derivation_type": derivation_type,
+                    },
+                    {
+                        "id": str(derivation_2),
+                        "used_id": str(used_id),
+                        "generated_id": str(generated_id),
+                        "derivation_type": derivation_type,
+                    },
+                ]
+            },
+        )
 
+    add_response(DerivationType.circuit_extraction)
     res = client.get_entity_derivations(
-        entity_id=entity_id,
-        entity_type=Circuit,
+        entity_id=entity_id, entity_type=Circuit, derivation_type=DerivationType.circuit_extraction
+    ).all()
+    assert len(res) == 2
+    assert res[0].id == derivation_1
+    assert res[1].id == derivation_2
+
+    add_response(DerivationType.circuit_rewiring)
+    res = client.get_entity_derivations(
+        entity_id=entity_id, entity_type=Circuit, derivation_type=DerivationType.circuit_rewiring
+    ).all()
+    assert len(res) == 2
+    assert res[0].id == derivation_1
+    assert res[1].id == derivation_2
+
+    add_response(DerivationType.unspecified)
+    res = client.get_entity_derivations(
+        entity_id=entity_id, entity_type=Circuit, derivation_type=DerivationType.unspecified
     ).all()
     assert len(res) == 2
     assert res[0].id == derivation_1