patch

Author: lbr38

documentation/docs/reference/api.md

@@ -37,6 +37,16 @@ Once generated, copy the key and keep it safe. This key is used to authenticate
 
     ``<SNAPSHOT_ID>`` can be retrieved from the URL when you browse a snapshot from the repositories list or from the API when you list snapshots of a repository.
 
+  ### Global query parameters
+
+  - ``normalize`` (optional): when set on a request, all keys in the JSON response are converted to lowercase recursively.
+
+  Example:
+
+  ```bash
+  curl --fail-with-body -L -s -X GET -H "Authorization: Bearer <APIKEY>" "https://repomanager.mydomain.net/api/v2/hosts/?normalize"
+  ```
+
 
 ### Source repositories
 

www/controllers/Api/Api.php

@@ -177,6 +177,12 @@ private static function returnSuccess(array $results): void
         // TODO: remove 'return' key in favor of 'rc' key in future major release
         $results['return'] = $results['rc'];
         $results['note'] = "The 'return' key is deprecated and will be removed in a future major release (replaced by 'rc' key)";
+
+        // If the "normalize" query parameter is set, convert all result keys to lowercase
+        if (isset($_GET['normalize'])) {
+            $results = Serializer::normalize($results);
+        }
+
         http_response_code((int) $results['rc']);
         echo json_encode($results);
         exit;

www/controllers/Api/Serializer.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Controllers\Api;
+
+class Serializer
+{
+    /**
+     *  Recursively normalize the keys of an array to lowercase
+     *  so that the API always returns a consistent key format, no matter
+     *  whether the data comes from the database (PascalCase columns) or
+     *  is built by the backend (lowercase keys).
+     */
+    public static function normalize($data)
+    {
+        // Only arrays have keys to normalize, return scalars as-is
+        if (!is_array($data)) {
+            return $data;
+        }
+
+        $result = [];
+
+        foreach ($data as $key => $value) {
+            // Recursively normalize nested arrays
+            $value = self::normalize($value);
+
+            // Numeric keys (sequential lists) are kept as-is
+            if (is_int($key)) {
+                $result[$key] = $value;
+                continue;
+            }
+
+            $result[strtolower($key)] = $value;
+        }
+
+        return $result;
+    }
+}

www/update/database/5.12.2.php

@@ -34,7 +34,6 @@
     throw new Exception('could not create new indexes for hosts table: ' . $e->getMessage());
 }
 
-// Add new settings in settings table
 try {
     // Add 'compliance_threshold_count' column if not exists
     if (!$hostsDb->columnExist('settings', 'compliance_threshold_count')) {
@@ -45,18 +44,29 @@
     if (!$hostsDb->columnExist('settings', 'compliance_threshold_days')) {
         $hostsDb->exec("ALTER TABLE settings ADD COLUMN compliance_threshold_days INTEGER NOT NULL DEFAULT 30");
     }
+} catch (Exception $e) {
+    throw new Exception('could not create new columns in hosts settings table: ' . $e->getMessage());
+}
 
+try {
     // Overwrite settings with old values if they exist
-    $hostsDb->exec("UPDATE settings SET compliance_threshold_count = (SELECT pkgs_count_considered_outdated FROM settings), compliance_threshold_days = 30");
+    if ($hostsDb->columnExist('settings', 'pkgs_count_considered_outdated')) {
+        $hostsDb->exec("UPDATE settings SET compliance_threshold_count = (SELECT pkgs_count_considered_outdated FROM settings)");
+    }
+} catch (Exception $e) {
+    throw new Exception('could not migrate old settings to new compliance_threshold_count in hosts settings table: ' . $e->getMessage());
+}
 
-    // Drop old settings columns
+try {
+    // Drop old 'pkgs_count_considered_outdated' column from settings table
     if ($hostsDb->columnExist('settings', 'pkgs_count_considered_outdated')) {
         $hostsDb->exec("ALTER TABLE settings DROP COLUMN pkgs_count_considered_outdated");
     }
 
+    // Drop old 'pkgs_count_considered_critical' column from settings table
     if ($hostsDb->columnExist('settings', 'pkgs_count_considered_critical')) {
         $hostsDb->exec("ALTER TABLE settings DROP COLUMN pkgs_count_considered_critical");
     }
 } catch (Exception $e) {
-    throw new Exception('could not add new settings columns in hosts settings table: ' . $e->getMessage());
+    throw new Exception('could not drop old settings columns in hosts settings table: ' . $e->getMessage());
 }