ExternalVendorCode/balena-supervisor
1
0
Fork 0
mirror of https://github.com/balena-os/balena-supervisor.git synced 2025-01-21 03:55:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #1712 from balena-os/fix-bullet-points-in-docs

Browse Source 
Revert multiline bullet points in notes
This commit is contained in:
bulldozer-balena[bot] 2021-05-26 14:56:16 +00:00 committed by GitHub
commit ab3e3d5b00
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/API.md
View File

@ -208,9 +208,7 @@ $ curl -X POST --header "Content-Type:application/json" \
### POST /v1/purge ### POST /v1/purge
> **Note:** > **Note:** This route will remove and recreate all service containers, as volumes can only be removed when their associated containers are removed. On devices with supervisor version lower than 7.22.0, replace all `BALENA_` variables with `RESIN_`, e.g. `RESIN_SUPERVISOR_ADDRESS` instead of `BALENA_SUPERVISOR_ADDRESS`.
> - On devices with supervisor version lower than 7.22.0, replace all `BALENA_` variables with `RESIN_`, e.g. `RESIN_SUPERVISOR_ADDRESS` instead of `BALENA_SUPERVISOR_ADDRESS`.
> - This will remove and recreate all service containers, as volumes can only be removed when their associated containers are removed.
Clears the user application's `/data` folder. Clears the user application's `/data` folder.
@ -259,9 +257,7 @@ $ curl -X POST --header "Content-Type:application/json" \
### POST /v1/restart ### POST /v1/restart
> **Note:** > **Note:** This route will remove and recreate all service containers. See [the restart action](https://www.balena.io/docs/learn/manage/actions/#restart-application) for more information. On devices with supervisor version lower than 7.22.0, replace all `BALENA_` variables with `RESIN_`, e.g. `RESIN_SUPERVISOR_ADDRESS` instead of `BALENA_SUPERVISOR_ADDRESS`.
> - On devices with supervisor version lower than 7.22.0, replace all `BALENA_` variables with `RESIN_`, e.g. `RESIN_SUPERVISOR_ADDRESS` instead of `BALENA_SUPERVISOR_ADDRESS`.
> - This will remove and recreate all service containers. See [the restart action](https://www.balena.io/docs/learn/manage/actions/#restart-application) for more information.
Restarts a user application container Restarts a user application container
@ -807,9 +803,7 @@ url when on the device list.
### POST /v2/applications/:appId/restart-service ### POST /v2/applications/:appId/restart-service
> **Note:** > **Note:** This route will remove and recreate the specified service container. See [the restart action](https://www.balena.io/docs/learn/manage/actions/#restart-application) for more information. On devices with supervisor version lower than 7.22.0, replace all `BALENA_` variables with `RESIN_`, e.g. `RESIN_SUPERVISOR_ADDRESS` instead of `BALENA_SUPERVISOR_ADDRESS`.
> - On devices with supervisor version lower than 7.22.0, replace all `BALENA_` variables with `RESIN_`, e.g. `RESIN_SUPERVISOR_ADDRESS` instead of `BALENA_SUPERVISOR_ADDRESS`.
> - This will remove and recreate the specified service container. See [the restart action](https://www.balena.io/docs/learn/manage/actions/#restart-application) for more information.
Added in supervisor version v7.0.0. Support for passing `serviceName` instead of Added in supervisor version v7.0.0. Support for passing `serviceName` instead of
`imageId` added in v8.2.2. `imageId` added in v8.2.2.
@ -877,9 +871,7 @@ This endpoint can also take an extra optional boolean, `force`, which if true in
### POST /v2/applications/:appId/restart ### POST /v2/applications/:appId/restart
> **Note:** > **Note:** This route will remove and recreate all service containers. See [the restart action](https://www.balena.io/docs/learn/manage/actions/#restart-application) for more information. On devices with supervisor version lower than 7.22.0, replace all `BALENA_` variables with `RESIN_`, e.g. `RESIN_SUPERVISOR_ADDRESS` instead of `BALENA_SUPERVISOR_ADDRESS`.
> - On devices with supervisor version lower than 7.22.0, replace all `BALENA_` variables with `RESIN_`, e.g. `RESIN_SUPERVISOR_ADDRESS` instead of `BALENA_SUPERVISOR_ADDRESS`.
> - This will remove and recreate all service containers. See [the restart action](https://www.balena.io/docs/learn/manage/actions/#restart-application) for more information.
Added in supervisor version v7.0.0. Added in supervisor version v7.0.0.