Skip to content

Commit 615f3b0

Browse files
authored
Document background addon install/update option (#2775)
1 parent e1e11bd commit 615f3b0

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

docs/api/supervisor/endpoints.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3264,6 +3264,12 @@ Returns information about a store add-on
32643264

32653265
Install an add-on from the store.
32663266

3267+
**Payload:**
3268+
3269+
| key | type | description |
3270+
| ---------- | ------- | --------------------------------------------------------------------------------------------------- |
3271+
| background | boolean | Return `job_id` immediately, do not wait for install to complete. Clients must check job for status |
3272+
32673273
</ApiEndpoint>
32683274

32693275
<ApiEndpoint path="/store/addons/<addon>/update" method="post">
@@ -3272,9 +3278,10 @@ Update an add-on from the store.
32723278

32733279
**Payload:**
32743280

3275-
| key | type | description |
3276-
| ------- | ------ | -------------------------------------------------------------- |
3277-
| backup | boolean | Create a partial backup of the add-on, default is false |
3281+
| key | type | description |
3282+
| ---------- | ------- | -------------------------------------------------------------------------------------------------- |
3283+
| backup | boolean | Create a partial backup of the add-on, default is false |
3284+
| background | boolean | Return `job_id` immediately, do not wait for update to complete. Clients must check job for status |
32783285

32793286
</ApiEndpoint>
32803287

0 commit comments

Comments
 (0)