API/Resources: Add examples for device pinning by UUID

Change-type: minor
balena-io · Sep 19, 2023 · 90470f1 · 90470f1
1 parent 64ffbcb
commit 90470f1
Showing 1 changed file with 27 additions and 18 deletions.
diff --git a/config/dictionaries/resource.json b/config/dictionaries/resource.json
@@ -324,6 +324,33 @@
         "endpoint": "/v6/device(<ID>)",
         "filters": "?\\$select=overall_status"
       },
+      {
+        "id": "get-target-release",
+        "summary": "Get the release device is pinned to",
+        "description": "Note: should_be_running__release will be unset or null if the device isn't pinned to any release. For an unpinned device, the device.is_running__release field may be used to obtain the device's current state.",
+        "method": "GET",
+        "endpoint": "/v6/device(<ID>)",
+        "filters": "?\\$select=should_be_running__release",
+        "data": ""
+      },
+      {
+        "id": "set-device-to-release-by-id",
+        "summary": "Pin device to a specific release by ID",
+        "description": "",
+        "method": "PATCH",
+        "endpoint": "/v6/device(<ID>)",
+        "filters": "",
+        "data": "{\n    \"should_be_running__release\": \"<RELEASE ID>\"\n}"
+      },
+      {
+        "id": "set-device-to-release-by-uuid",
+        "summary": "Pin device to a specific release by UUID",
+        "description": "",
+        "method": "PATCH",
+        "endpoint": "/v6/device(uuid='<UUID>')",
+        "filters": "",
+        "data": "{\n    \"should_be_running__release\": \"<RELEASE ID>\"\n}"
+      },
       {
         "id": "rename-device",
         "summary": "Rename device",
@@ -359,24 +386,6 @@
         "filters": "",
         "data": "{\n    \"belongs_to__application\": \"<FLEET ID>\"\n}"
       },
-      {
-        "id": "get-target-release",
-        "summary": "Get the release device is pinned to",
-        "description": "Note: should_be_running__release will be unset or null if the device isn't pinned to any release. For an unpinned device, the device.is_running__release field may be used to obtain the device's current state.",
-        "method": "GET",
-        "endpoint": "/v6/device(<ID>)",
-        "filters": "?\\$select=should_be_running__release",
-        "data": ""
-      },
-      {
-        "id": "set-device-to-release",
-        "summary": "Pin device to a specific release",
-        "description": "",
-        "method": "PATCH",
-        "endpoint": "/v6/device(<ID>)",
-        "filters": "",
-        "data": "{\n    \"should_be_running__release\": \"<RELEASE ID>\"\n}"
-      },
       {
         "id": "deactivate-device",
         "summary": "Deactivate an offline device (CHARGEABLE)",