ExternalVendorCode/balena-supervisor
1
0
Fork 0
mirror of https://github.com/balena-os/balena-supervisor.git synced 2025-01-31 08:25:36 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Document that the update lock can be forced on reboots and shutdowns

Browse Source 
Closes #373
Change-Type: patch
Signed-off-by: Pablo Carranza Velez <pablo@resin.io>
This commit is contained in:
Pablo Carranza Velez 2018-03-15 17:17:29 -03:00
parent e1e33b376e
commit 5d7d99c258
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/API.md
View File

@ -108,7 +108,9 @@ $ curl -X POST --header "Content-Type:application/json" \
### POST /v1/reboot ### POST /v1/reboot
Reboots the device Reboots the device. This will first try to stop applications, and fail if there is an update lock.
An optional "force" parameter in the body overrides the lock when true (and the lock can also be overridden from
the dashboard).
When successful, responds with 202 accepted and a JSON object: When successful, responds with 202 accepted and a JSON object:
```json ```json
@ -119,6 +121,9 @@ When successful, responds with 202 accepted and a JSON object:
``` ```
(This is implemented in Go) (This is implemented in Go)
#### Request body
Can contain a `force` property, which if set to `true` will cause the update lock to be overridden.
#### Examples: #### Examples:
From the app on the device: From the app on the device:
```bash ```bash
@ -142,7 +147,9 @@ $ curl -X POST --header "Content-Type:application/json" \
### POST /v1/shutdown ### POST /v1/shutdown
**Dangerous**. Shuts down the device. **Dangerous**. Shuts down the device. This will first try to stop applications, and fail if there is an update lock.
An optional "force" parameter in the body overrides the lock when true (and the lock can also be overridden from
the dashboard).
When successful, responds with 202 accepted and a JSON object: When successful, responds with 202 accepted and a JSON object:
```json ```json
@ -153,6 +160,9 @@ When successful, responds with 202 accepted and a JSON object:
``` ```
(This is implemented in Go) (This is implemented in Go)
#### Request body
Can contain a `force` property, which if set to `true` will cause the update lock to be overridden.
#### Examples: #### Examples:
From the app on the device: From the app on the device:
```bash ```bash