88 Commits

Author SHA1 Message Date
Mike Degatano
9dbcd03e4c
Document supervisor's new /auth/list endpoint (#2085)
Co-authored-by: Stefan Agner <stefan@agner.ch>
Co-authored-by: Franck Nijhof <git@frenck.dev>
2024-06-08 11:21:28 +02:00
Mike Degatano
705d66ea98
Document safe mode option for /core/rebuild (#2204) 2024-06-08 09:17:43 +02:00
c0ffeeca7
2f2c7db974
API: apply sentence-style capitalization to headings (#2186)
* API: apply sentence-style capitalization to headings

- to comply with MS Style Guide on [capitalization](https://learn.microsoft.com/en-us/style-guide/capitalization)

* Update docs/api/native-app-integration/webview.md
2024-05-23 10:01:07 +02:00
Jan Čermák
b128985b2d
Document new logging endpoints in Supervisor API (#2124)
Document endpoints using the Systemd "advanced logs" features.
2024-04-25 11:23:01 +02:00
Jan Čermák
f409e414a6
Document "Accept: text/x-log" in Supervisor host logs API (#2123)
This was added in https://github.com/home-assistant/supervisor/pull/4963
and available since Supervisor 2024.03.1.
2024-04-25 10:46:14 +02:00
Stefan Agner
4834760564
Supervisor: Fix possible states of add-on's boot property (#2146)
The boot property can either be "auto" or "manual".
2024-04-17 16:01:22 +02:00
Mike Degatano
848e05641c
Document safe_mode option on /core/restart (#2143) 2024-04-17 08:59:00 +02:00
Mike Degatano
aba5b6af91
Add drive info to /hardware/info (#1684) 2024-03-22 11:39:33 +01:00
Mike Degatano
a7f7da3084
Document new /os/boot-slot endpoint (#2107)
* Document new /os/boot-slot endpoint

* `boot_name` to `boot_slot`
2024-03-21 18:47:06 +01:00
Mike Degatano
c4d46ba490
Document virtualization field in API (#2117) 2024-03-21 18:44:35 +01:00
Mike Degatano
7e76189ae8
Document device wipe API (#2097)
* Document device wipe API

* Tweak wording

* Remove trailing space

* Change doc to mention os level settings wipe

* Replace you with user as this is API doc

* Mention boot config preserved
2024-03-01 17:10:56 +01:00
Mike Degatano
30e88c9d97
Document remove config on uninstall option (#2086) 2024-03-01 16:07:12 +01:00
Mike Degatano
8e100fdb4c
Document read_only option for mounts (#2071) 2024-03-01 15:53:12 +01:00
Mike Degatano
2afdce29d7
Document new backup option and model changes in backup/restore (#2049) 2024-02-28 11:24:00 +01:00
Mike Degatano
23209d9e53
Document API options for excluding DB from backups (#1941) 2023-10-11 09:09:54 +02:00
Mike Degatano
3ffba09d19
Document jobs api (#1896) 2023-10-06 21:09:23 +02:00
Mike Degatano
7a01aea2e2
Document new endpoints for green board (#1905) 2023-10-06 21:06:56 +02:00
Mike Degatano
8f5c54cae0
Document new freeze and thaw APIs in supervisor (#1902) 2023-09-09 10:54:50 +02:00
Florian Bachmann
72871b7783
Updates docs for remote-user (#1691)
* Updates docs for remote-user

* Update configuration.md

* Update endpoints.md

* Update security.md
2023-08-24 16:25:25 +02:00
Stephen Beechen
950632bfad
Document default_backup_mount in the /mount endpoint (#1798) 2023-06-27 21:20:38 +02:00
Joakim Sørensen
162389d597
Add documentation for the location key in backups (#1791)
* Add documentation for the location key in backups

* Apply suggestions from code review

* Tiny tweak. My mistake from before.

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
2023-06-15 16:18:59 +02:00
Mike Degatano
df69143c32
Document new backup location options (#1777) 2023-05-21 15:06:17 +02:00
Mike Degatano
dd6d3a0de4
Document new APIs around network mounts (#1762) 2023-05-01 08:46:32 +02:00
Mike Degatano
4b1a500956
Data disk APIs use UDisks2 info (#1727) 2023-03-27 12:09:31 -04:00
Stefan Agner
fa73df9110
Document host_uts add-on support (#1310) 2023-02-13 14:41:41 +01:00
Daniel
caf800df22
Fix wrong type and description of ingress_panel (#1548) 2022-11-24 19:33:07 +01:00
Mike Degatano
f2fd582ba1
Document /os/boards/{board} endpoints (#1526)
* Document `/os/boards/{board}` endpoints

* Missed closing tag
2022-11-08 09:29:13 +01:00
Stefan Agner
fcafabfc9e
Add documentation for enhanced logging endpoints (#1127)
* Add documentation for enhanced logging endpoints

* Document all log endpoints and options

* Update with latest endpoints

* Missed a closing tag

* Add other /follow endpoints

* Note link to /host/logs for range info

* Only modify /host/logs endpoints

Co-authored-by: Mike Degatano <michael.degatano@gmail.com>
2022-10-21 20:14:16 +02:00
Pascal Vizeli
3b30cea057
Add missing store endpoints (#1416) 2022-10-21 20:13:15 +02:00
Mike Degatano
269a582faa
Document new options for supervisor backups (#1442) 2022-10-17 13:45:47 +02:00
Mike Degatano
439273cce6
Document new suggestions for issue api (#1444) 2022-08-29 20:30:19 +02:00
Mike Degatano
a10b5ed45f
Document supervisor auto update option 2022-08-10 20:54:49 -04:00
Martin Hjelmare
ae713239bf
Fix store addons addon api response (#1422) 2022-08-02 18:59:13 +02:00
Pascal Vizeli
9cc60fa935
Add CAS Codenotary & cleanup old stuff (#1213)
* Add CAS Codenotary

* Update docs/add-ons/security.md

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>
2022-06-23 14:54:21 +02:00
Joakim Sørensen
68c88d3400
Add extended store addon info (#1358) 2022-06-09 15:38:39 -07:00
Mike Degatano
0f040fc5c0
Document store APIs for add/remove repository (#1354) 2022-06-01 20:52:34 +02:00
Pascal Vizeli
20cf80ebe7
Integrity check (#1316)
* Add integrity check documentation

* add untested

* Add examples

* Update docs/api/supervisor/endpoints.md

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>

* Update docs/api/supervisor/endpoints.md

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>
2022-05-02 13:37:12 +02:00
Mike Degatano
a69ae4e832
Document disable fallback DNS option in API (#1303) 2022-04-28 14:23:33 +02:00
Mike Degatano
060292b0b4
Add llmnr and mdns fields to API doc (#1286) 2022-04-11 19:29:12 +02:00
Joakim Sørensen
d06b791272
Add homeassistant to partial backup endpoint (#1225) 2022-02-23 08:58:34 -08:00
Marco Trevisan
4d2e55f16a
API: Mention compressed parameter for performing backups (#1188)
Related to: https://github.com/home-assistant/supervisor/pull/3378
2022-02-03 10:25:26 +01:00
Joakim Sørensen
4330a6f0c2
Add new root endpoints (#1193) 2022-01-24 10:38:52 +01:00
Joakim Sørensen
b055866eb4
Add size to backup list endpoint (#1187) 2022-01-19 12:46:52 -08:00
Joakim Sørensen
ed660ba2a8
Add update backup payload (#1158)
* Add update backup payload

* Add Optionally

* Add Optionally

* Use defaults
2021-12-28 11:15:09 +01:00
Joakim Sørensen
fa7da449e0
Add documentation for /supervisor/available_updates (#1135) 2021-12-14 01:33:22 +01:00
Stefan Agner
448c7c2335
Add missing options to Supervisor's core/options endpoint (#1146) 2021-11-30 19:18:14 +01:00
Pascal Vizeli
a9407a2cb4
Add AppArmor version (#1110) 2021-10-27 14:58:55 +02:00
Joakim Sørensen
2d3f70a129
Add docs for boot_timestamp and startup_time (#1064) 2021-09-22 11:16:16 +02:00
Pascal Vizeli
ce4c675ed4
Datadisk list feature (#1063) 2021-09-21 15:49:16 +02:00
Pascal Vizeli
6e795cd74b
Host agent version on API (for CLI debugging) (#1058) 2021-09-17 09:27:51 -07:00