Drop deprecated method device.startApplication

Change-type: major
balena-io · Jan 15, 2025 · 55e6c42 · 55e6c42
1 parent 62ff5fd
commit 55e6c42
Show file tree

Hide file tree

Showing 2 changed files with 0 additions and 84 deletions.
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
@@ -304,7 +304,6 @@ const sdk = fromSharedOptions();
             * [.ping(uuidOrId)](#balena.models.device.ping) ⇒ <code>Promise</code>
             * [.identify(uuidOrId)](#balena.models.device.identify) ⇒ <code>Promise</code>
             * [.restartApplication(uuidOrId)](#balena.models.device.restartApplication) ⇒ <code>Promise</code>
-            * ~~[.startApplication(uuidOrId)](#balena.models.device.startApplication) ⇒ <code>Promise</code>~~
             * ~~[.stopApplication(uuidOrId)](#balena.models.device.stopApplication) ⇒ <code>Promise</code>~~
             * [.reboot(uuidOrId, [options])](#balena.models.device.reboot) ⇒ <code>Promise</code>
             * [.shutdown(uuidOrId, [options])](#balena.models.device.shutdown) ⇒ <code>Promise</code>
@@ -710,7 +709,6 @@ balena.models.device.get(123).catch(function (error) {
         * [.ping(uuidOrId)](#balena.models.device.ping) ⇒ <code>Promise</code>
         * [.identify(uuidOrId)](#balena.models.device.identify) ⇒ <code>Promise</code>
         * [.restartApplication(uuidOrId)](#balena.models.device.restartApplication) ⇒ <code>Promise</code>
-        * ~~[.startApplication(uuidOrId)](#balena.models.device.startApplication) ⇒ <code>Promise</code>~~
         * ~~[.stopApplication(uuidOrId)](#balena.models.device.stopApplication) ⇒ <code>Promise</code>~~
         * [.reboot(uuidOrId, [options])](#balena.models.device.reboot) ⇒ <code>Promise</code>
         * [.shutdown(uuidOrId, [options])](#balena.models.device.shutdown) ⇒ <code>Promise</code>
@@ -2254,7 +2252,6 @@ balena.models.application.revokeSupportAccess(123);
     * [.ping(uuidOrId)](#balena.models.device.ping) ⇒ <code>Promise</code>
     * [.identify(uuidOrId)](#balena.models.device.identify) ⇒ <code>Promise</code>
     * [.restartApplication(uuidOrId)](#balena.models.device.restartApplication) ⇒ <code>Promise</code>
-    * ~~[.startApplication(uuidOrId)](#balena.models.device.startApplication) ⇒ <code>Promise</code>~~
     * ~~[.stopApplication(uuidOrId)](#balena.models.device.stopApplication) ⇒ <code>Promise</code>~~
     * [.reboot(uuidOrId, [options])](#balena.models.device.reboot) ⇒ <code>Promise</code>
     * [.shutdown(uuidOrId, [options])](#balena.models.device.shutdown) ⇒ <code>Promise</code>
@@ -4064,34 +4061,6 @@ balena.models.device.restartApplication('7cf02a6');
 ```js
 balena.models.device.restartApplication(123);
 ```
-<a name="balena.models.device.startApplication"></a>
-
-##### ~~device.startApplication(uuidOrId) ⇒ <code>Promise</code>~~
-***Deprecated***
-
-This is not supported on multicontainer devices, and will be removed in a future major release
-
-**Kind**: static method of [<code>device</code>](#balena.models.device)  
-**Summary**: Start application on device  
-**Access**: public  
-**Fulfil**: <code>String</code> - application container id  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| uuidOrId | <code>String</code> \| <code>Number</code> | device uuid (string) or id (number) |
-
-**Example**  
-```js
-balena.models.device.startApplication('7cf02a6').then(function(containerId) {
-	console.log(containerId);
-});
-```
-**Example**  
-```js
-balena.models.device.startApplication(123).then(function(containerId) {
-	console.log(containerId);
-});
-```
 <a name="balena.models.device.stopApplication"></a>
 
 ##### ~~device.stopApplication(uuidOrId) ⇒ <code>Promise</code>~~

diff --git a/src/models/device.supervisor-api.partial.ts b/src/models/device.supervisor-api.partial.ts
@@ -214,59 +214,6 @@ export const getSupervisorApiHelper = function (
 				}
 			}),
 
-		/**
-		 * @summary Start application on device
-		 * @name startApplication
-		 * @public
-		 * @function
-		 * @memberof balena.models.device
-		 *
-		 * @deprecated
-		 * @description
-		 * This is not supported on multicontainer devices, and will be removed in a future major release
-		 *
-		 * @param {String|Number} uuidOrId - device uuid (string) or id (number)
-		 * @fulfil {String} - application container id
-		 * @returns {Promise}
-		 *
-		 * @example
-		 * balena.models.device.startApplication('7cf02a6').then(function(containerId) {
-		 * 	console.log(containerId);
-		 * });
-		 *
-		 * @example
-		 * balena.models.device.startApplication(123).then(function(containerId) {
-		 * 	console.log(containerId);
-		 * });
-		 */
-		startApplication: async (uuidOrId: string | number): Promise<void> => {
-			const deviceOptions = {
-				$select: ['id', 'supervisor_version'],
-				$expand: { belongs_to__application: { $select: 'id' } },
-			} satisfies PineOptions<Device>;
-			const device = (await sdkInstance.models.device.get(
-				uuidOrId,
-				deviceOptions,
-			)) as PineTypedResult<Device, typeof deviceOptions>;
-			ensureVersionCompatibility(
-				device.supervisor_version,
-				MIN_SUPERVISOR_APPS_API,
-				'supervisor',
-			);
-			const appId = device.belongs_to__application[0].id;
-			const { body } = await request.send({
-				method: 'POST',
-				url: `/supervisor/v1/apps/${appId}/start`,
-				baseUrl: apiUrl,
-				body: {
-					deviceId: device.id,
-					appId,
-				},
-				timeout: CONTAINER_ACTION_ENDPOINT_TIMEOUT,
-			});
-			return body.containerId;
-		},
-
 		/**
 		 * @summary Stop application on device
 		 * @name stopApplication