Merge pull request #131 from oslokommune/pipeline-instance-query

Support pipeline instance dataset/version filter

Author: simenheg

CHANGELOG.md

@@ -3,6 +3,8 @@
 * Added support for Python 3.13.
 * Dropped support for Python 3.8 which has reached end of life. Python 3.9+ is
   now required.
+* `PipelineApiClient.get_pipeline_instances` now supports querying pipeline
+  instances by dataset ID and version.
 
 ## 3.2.0 - 2024-10-03
 

okdata/sdk/pipelines/client.py

@@ -19,14 +19,21 @@ def exists(self, base: Type[PipelineBase], id):
     def fetch(self, base: Type[PipelineBase], id):
         return base.from_id(self, id)
 
-    def list(self, base: Type[PipelineBase]):
-        return base.list(self)
+    def list(self, base: Type[PipelineBase], params={}):
+        return base.list(self, params)
 
     def get_pipelines(self) -> List[Pipeline]:
         return self.list(Pipeline)
 
-    def get_pipeline_instances(self) -> List[PipelineInstance]:
-        return self.list(PipelineInstance)
+    def get_pipeline_instances(self, dataset_id=None, version=None):
+        return self.list(
+            PipelineInstance,
+            (
+                {"dataset-id": dataset_id, "version": version}
+                if dataset_id and version
+                else {}
+            ),
+        )
 
     def get_schemas(self) -> List[Schema]:
         return self.list(Schema)

okdata/sdk/pipelines/resources/pipeline_base.py

@@ -140,7 +140,7 @@ def delete(self):
         raise NotImplementedError
 
     @classmethod
-    def list(cls, sdk: SDK):
+    def list(cls, sdk: SDK, params={}):
         """List instances of this pipeline resource
 
         Args:
@@ -150,7 +150,7 @@ def list(cls, sdk: SDK):
         """
         base_url = sdk.config.get("pipelineUrl")
         url = f"{base_url}/{cls.__resource_name__}"
-        return sdk.get(url=url).json()
+        return sdk.get(url=url, params=params).json()
 
     def update(self):
         """Update the pipeline resource