Merge pull request #3067 from balena-io/device-env-vars-uuid-filter

API/resources: Add docs on how to retrieve device env vars & device service env vars by device UUID
balena-io · Sep 2, 2024 · 8a78f3c · 8a78f3c
2 parents 859a6fa + 2b3e0dc
commit 8a78f3c
Showing 1 changed file with 18 additions and 2 deletions.
diff --git a/config/dictionaries/resource.json b/config/dictionaries/resource.json
@@ -550,9 +550,17 @@
       "value"
     ],
     "examples": [
+      {
+        "id": "get-device-env-vars-by-device-uuid",
+        "summary": "Get all device environment variables for a device by UUID",
+        "description": "",
+        "method": "GET",
+        "endpoint": "/v6/device_environment_variable",
+        "filters": "?\\$filter=device/any(d:d/uuid%20eq%20'<DEVICE_UUID>')"
+      },
       {
         "id": "get-device-env-vars",
-        "summary": "Get all device environment variables for a device",
+        "summary": "Get all device environment variables for a device by ID",
         "description": "",
         "method": "GET",
         "endpoint": "/v6/device_environment_variable",
@@ -599,7 +607,15 @@
     "examples": [
       {
         "id": "get-device-service-vars",
-        "summary": "Get all service variables for a device",
+        "summary": "Get all service variables for a device by UUID",
+        "description": "",
+        "method": "GET",
+        "endpoint": "/v6/device_service_environment_variable",
+        "filters": "?\\$filter=service_install/any(si:si/device/any(d:d/uuid%20eq%20'<DEVICE_UUID>'))"
+      },
+      {
+        "id": "get-device-service-vars",
+        "summary": "Get all service variables for a device by ID",
         "description": "",
         "method": "GET",
         "endpoint": "/v6/device_service_environment_variable",