Skip to content

Commit 07b5c19

Browse files
authored
Document system managed field for addons (#2226)
* Document system managed field for addons * Adjusting wording from coderabbit feedback * System managed fields separated into new endpoint * Remove unnecessary changes
1 parent 5dee7c2 commit 07b5c19

File tree

2 files changed

+34
-5
lines changed

2 files changed

+34
-5
lines changed

docs/api/supervisor/endpoints.md

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ Return overview information about installed add-ons.
4242
"build": false,
4343
"url": null,
4444
"icon": false,
45-
"logo": false
45+
"logo": false,
46+
"system_managed": false
4647
}
4748
]
4849
}
@@ -165,7 +166,9 @@ Get details about an add-on
165166
| startup | string | The stage when the add-on is started (initialize, system, services, application, once) |
166167
| state | string or null | The state of the add-on (started, stopped) |
167168
| stdin | boolean | `true` if the add-on accepts stdin commands |
168-
| translations | dictionary | A dictionary containing content of translation files for the add-on |
169+
| system_managed | boolean | Indicates whether the add-on is managed by Home Assistant |
170+
| system_managed_config_entry | string | Provides the configuration entry ID if the add-on is managed by Home Assistant |
171+
| translations | dictionary | A dictionary containing content of translation files for the add-on |
169172
| udev | boolean | `true` if udev access is granted is enabled |
170173
| update_available | boolean | `true` if an update is available |
171174
| url | string or null | URL to more information about the add-on |
@@ -241,6 +244,8 @@ Get details about an add-on
241244
"startup": "application",
242245
"state": "started",
243246
"stdin": false,
247+
"system_managed": true,
248+
"system_managed_config_entry": "abc123",
244249
"translations": {
245250
"en": {
246251
"configuration": {
@@ -275,9 +280,7 @@ Get the add-on logo
275280
</ApiEndpoint>
276281

277282
<ApiEndpoint path="/addons/<addon>/options" method="post">
278-
Set the protection mode on an add-on.
279-
280-
This function is not callable by itself and you can not use `self` as the slug here.
283+
Set the options for an add-on.
281284

282285
:::tip
283286
To reset customized network/audio/options, set it `null`.
@@ -316,6 +319,31 @@ To reset customized network/audio/options, set it `null`.
316319

317320
</ApiEndpoint>
318321

322+
<ApiEndpoint path="/addons/<addon>/sys_options" method="post">
323+
Change options specific to system managed addons.
324+
325+
This endpoint is only callable by Home Assistant and not by any other client.
326+
327+
**Payload**
328+
329+
| key | type | description |
330+
| --------------------------- | ------------- | --------------------------------------- |
331+
| system_managed | boolean | `true` if managed by Home Assistant |
332+
| system_managed_config_entry | boolean | ID of config entry managing addon |
333+
334+
**You need to supply at least one key in the payload.**
335+
336+
**Example payload:**
337+
338+
```json
339+
{
340+
"system_managed": true,
341+
"system_managed_config_entry": "abc123"
342+
}
343+
```
344+
345+
</ApiEndpoint>
346+
319347
<ApiEndpoint path="/addons/<addon>/options/validate" method="post">
320348
Run a configuration validation against the current stored add-on configuration or payload.
321349

docs/api/supervisor/models.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ These models are describing objects that are getting returned from the superviso
2121
| icon | bool | The add-on has an icon file |
2222
| logo | bool | The add-on has a logo file |
2323
| state | string | The state of the add-on (started, stopped) |
24+
| system_managed | bool | Indicates whether the add-on is managed by Home Assistant |
2425

2526
## Application
2627

0 commit comments

Comments
 (0)