Enhance documentation for detached_mode OS update

Change-type: patch Signed-off-by: Ken Bannister <[email protected]>
balena-io · Feb 18, 2025 · e4fa488 · e4fa488
1 parent 347e059
commit e4fa488
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
@@ -1539,6 +1539,7 @@ Get device name by device uuid.
 <a name="device.get_os_update_status"></a>
 ### Function: get_os_update_status(uuid_or_id) ⇒ <code>HUPStatusResponse</code>
 
+***Deprecated***
 Get the OS update status of a device.
 
 #### Args:
@@ -1970,6 +1971,9 @@ This function requires supervisor v1.8 or higher.
 
 Start an OS update on a device.
 
+If using run_detached option, monitor progress with device.get() --
+status, provisioning_state and provisioning_progress entries.
+
 #### Args:
     uuid_or_id (Union[str, int]): device uuid (string) or id (int).
     target_os_version (str): semver-compatible version for the target device.

diff --git a/balena/models/device.py b/balena/models/device.py
@@ -1737,6 +1737,9 @@ def start_os_update(
         """
         Start an OS update on a device.
 
+        If using run_detached option, monitor progress with device.get() --
+        status, provisioning_state and provisioning_progress entries.
+
         Args:
             uuid_or_id (Union[str, int]): device uuid (string) or id (int).
             target_os_version (str): semver-compatible version for the target device.
@@ -1796,6 +1799,7 @@ def start_os_update(
     )
     def get_os_update_status(self, uuid_or_id: Union[str, int]) -> HUPStatusResponse:
         """
+        ***Deprecated***
         Get the OS update status of a device.
 
         Args: