Updated API

Author: rimi-itk

README.md

@@ -25,13 +25,12 @@ task site:update
 Run
 
 ``` shell
-git submodule update --init
-# Apply a patch to support MySQL in the API and make building it work.
-git -C api apply < patches/Process_Dashboard_API.patch
 task site:update
 ```
 
-to get things started.
+> [!NOTE]
+> Running `task site:update` on [macOS (darwin)](https://en.wikipedia.org/wiki/Darwin_(operating_system)) will pull and
+> patch the API Git submodule (cf. [#api](API)). See [`Taskfile.yml`](Taskfile.yml) for details.
 
 Load fixtures with
 
@@ -73,6 +72,17 @@ task api:get API_PATH='/api/v1/runs/?process_id=1&meta_filter=name:Gregory%20Men
 
 See [`docker-compose.api.yml`](docker-compose.api.yml) for the docker compose setup for the API.
 
+## Updating the API
+
+Run
+
+``` shell
+task api:update
+```
+
+to update the API to the latest version (the [`main`
+branch](https://github.com/AAK-MBU/Process_Dashboard_API/tree/main)).
+
 ### Loading data
 
 ``` shell

Taskfile.yml

@@ -37,6 +37,16 @@ tasks:
       - task: compose
         vars:
           TASK_ARGS: pull
+
+      # Additional setup for local development (assuming we're running on maxOS (darwin))
+      - cmd: |
+          git -C api checkout .
+          git submodule update --init
+          # Apply a patch to support MySQL in the API and make building it work.
+          git -C api apply < patches/Process_Dashboard_API.patch
+        # https://taskfile.dev/docs/reference/schema#platforms
+        platforms: [darwin]
+
       - task: compose
         vars:
           TASK_ARGS: up --build --detach --wait
@@ -155,6 +165,16 @@ tasks:
         vars:
           SCRIPT_PATH: scripts/api/fixtures.py
 
+  api:update:
+    desc: Update API to latest version (https://github.com/AAK-MBU/Process_Dashboard_API/tree/main)
+    prompt: Really?
+    cmds:
+      - git -C api checkout .
+      - git -C api checkout main
+      - git -C api pull
+      # Check that our patch can be applied.
+      - git -C api apply --check < patches/Process_Dashboard_API.patch
+
   api:script:run:
     desc: "Run script inside API service container, example: `task {{.TASK}} SCRIPT_PATH=test/load_data.py"
     silent: true

api

@@ -1,27 +1,12 @@
 diff --git a/pyproject.toml b/pyproject.toml
-index 15be699..0933d91 100644
+index b3adc84..f92da38 100644
 --- a/pyproject.toml
 +++ b/pyproject.toml
-@@ -21,6 +21,7 @@ dependencies = [
-     "python-dotenv>=1.0.0",
+@@ -22,6 +22,7 @@ dependencies = [
      "python-multipart>=0.0.6",
      "python-jose[cryptography]>=3.3.0",
+     "fastapi-pagination>=0.14.3",
 +    "pymysql>=1.1.2",
  ]
 
  [project.optional-dependencies]
-diff --git a/uv.lock b/uv.lock
-index 67c564a..ad82d70 100644
---- a/uv.lock
-+++ b/uv.lock
-@@ -350,8 +350,8 @@ wheels = [
- ]
- 
- [[package]]
--name = "process-visualization-api"
--version = "1.0.0"
-+name = "process-dashboard-api"
-+version = "1.1.0"
- source = { editable = "." }
- dependencies = [
-     { name = "fastapi" },

patches/Process_Dashboard_API.patch

@@ -18,12 +18,12 @@ public function __construct(
 
     public function getProcesses(DataSource $dataSource): array
     {
-        return $this->get($dataSource, 'processes/processes');
+        return $this->get($dataSource, 'processes/');
     }
 
     public function getProcess(DataSource $dataSource, string $processId): array
     {
-        return $this->get($dataSource, 'processes/processes/'.$processId);
+        return $this->get($dataSource, 'processes/'.$processId);
     }
 
     public function getProcessRun(DataSource $dataSource, string $processId, array $query): array

src/DataSourceHelper.php

@@ -53,7 +53,7 @@ public function getData(Request $request, ProcessOverview $overview): array
             }
 
             $rows = [];
-            $items = $data;
+            $items = $data['items'] ?? [];
             foreach ($items as $item) {
                 $steps = $item['steps'] ?? null;
                 if (!$steps) {