Stefan Agner
a5c8faad38
Add machine ID to Supervisor root info ( #2703 )
2025-06-18 22:22:40 +02:00
Stefan Agner
dc3e242c2e
Add reload updates for main components ( #2651 )
2025-04-24 23:13:06 +02:00
Christian Steinert
742f2e9efb
Add entity delete endpoint (REST API) to docs ( #2646 )
2025-04-22 12:22:58 +02:00
Jan Čermák
984daee8bd
Add documentation for Supervisor /os/config/swap API ( #2611 )
2025-03-31 14:14:02 +02:00
Jack Gaino
d3f358deb3
Document API behaviour for service response data ( #2137 )
...
* Document API behaviour for service response data
Adds documentation for a new query/JSON parameter called `return_response`. It allows users to retrieve service response data instead of state changes when calling a service using the API.
* Update documentation to match new implementation
* Fix typo
* Explicitly mention 400 in response
* Apply suggestions from code review
Co-authored-by: J. Nick Koston <nick+github@koston.org>
---------
Co-authored-by: Erik Montnemery <erik@montnemery.com>
Co-authored-by: J. Nick Koston <nick+github@koston.org>
2025-03-17 16:01:28 +01:00
Mike Degatano
07b5c19907
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
2025-03-02 23:37:06 +01:00
Thomas Kilgour
776681d0e2
add start and end times to calendars enpoint in rest.md ( #2559 )
2025-03-02 23:35:26 +01:00
Max Rydahl Andersen
6239a77559
document coalesce feature ( #2128 )
...
* document coalesce feature
* Update docs/api/websocket.md
Co-authored-by: J. Nick Koston <nick@koston.org>
---------
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
Co-authored-by: J. Nick Koston <nick@koston.org>
Co-authored-by: Franck Nijhof <git@frenck.dev>
2025-02-06 22:19:23 +01:00
Mike Degatano
7c8914fc8c
Document created field for jobs ( #2550 )
2025-01-31 16:24:53 +01:00
Mike Degatano
d46aa77cc3
Document force options in supervisor endpoints ( #2260 )
2024-10-08 22:01:08 +02:00
Mike Degatano
3a4a8f413c
Document manual_only option for addon boot mode ( #2286 )
...
* Document manual_forced option for addon boot mode
* `manual_forced` to `manual_only`
2024-08-27 18:02:27 +02:00
Franck Nijhof
20c58b1128
Rename Services to Service actions in more places ( #2250 )
2024-07-16 12:30:23 +02:00
Franck Nijhof
8eeaf3af91
Rename Services to Service actions ( #2249 )
...
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2024-07-16 12:05:05 +02:00
Rob Coleman
394fc9777c
Clarify the meaning and usage of the "id" field in a websocket message ( #2244 )
2024-07-09 18:20:11 +02:00
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
c0ffeeca7
6b538ce7f4
Add-ons: apply sentence-style capitalization to headings ( #2185 )
...
* Add-ons: apply sentence-style capitalization to headings
- to comply with MS Style Guide on [capitalization](https://learn.microsoft.com/en-us/style-guide/capitalization )
* Fix name
2024-05-23 10:00:49 +02:00
Andy Castille
3b56f583a4
Add note about return_response to example of calling a service via the WS API ( #2156 )
2024-04-26 10:13:31 +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
Martin Hjelmare
44c7661712
Remove rest api service timeout ( #1996 )
2023-11-29 14:46:39 +01:00
Jan Bouwhuis
f85fa4cbbb
Add ServiceValidationError and translation support ( #1961 )
...
* Add ServiceValidationError and translation support
* Improvements, add blog post
* Add error handling response
* Follow up comment
* Update blog/2023-10-29-service-exceptions-and-translations.md
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
* Update blog/2023-10-29-service-exceptions-and-translations.md
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
* Follow up raising vs handling errors
* Fix links
* Update docs/core/platform/raising_exceptions.md
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
* Update blog/2023-10-29-service-exceptions-and-translations.md
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
* Update docs/api/websocket.md
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
* Update docs/internationalization/core.md
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
* Update docs/internationalization/core.md
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
* Update docs/core/platform/raising_exceptions.md
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
* Update docs/integration_quality_scale_index.md
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
* Update docs/internationalization/core.md
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
* Update blog/2023-10-29-service-exceptions-and-translations.md
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
* Rename file to adjust date
---------
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
2023-11-17 15:36:19 +01:00
Raman Gupta
ce381b54bc
Update docs for call_service WS API ( #1881 )
...
* Update docs for call_service WS API
* Update websocket.md
2023-11-10 21:45:12 +01:00
Mike Degatano
23209d9e53
Document API options for excluding DB from backups ( #1941 )
2023-10-11 09:09:54 +02:00
Andrew Dickinson
d93f305a56
Add URL to WebSocket API documentation ( #1202 )
...
Co-authored-by: Paulus Schoutsen <paulus@home-assistant.io>
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
2023-10-06 21:19:52 +02:00
Mike Degatano
3ffba09d19
Document jobs api ( #1896 )
2023-10-06 21:09:23 +02:00
4nd2in
1fd39795ad
Fix curl samples for history end point in REST API documentation ( #1899 )
...
Co-authored-by: 4nd2in <andrin.weiler@smoca.ch>
2023-10-06 21:09:04 +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
454db1b207
Include share as mount usage option ( #1786 )
...
Co-authored-by: Franck Nijhof <git@frenck.dev>
2023-05-29 11:41:52 +02:00
Mike Degatano
df69143c32
Document new backup location options ( #1777 )
2023-05-21 15:06:17 +02:00
J. Nick Koston
391fa8c3bd
Update rest documentation for filter_entity_id as its required ( #1770 )
2023-05-07 01:05:14 +02:00
Mike Degatano
dd6d3a0de4
Document new APIs around network mounts ( #1762 )
2023-05-01 08:46:32 +02:00
Sven Serlier
da60ee6f6a
Update URLs ( #1745 )
2023-04-12 23:21:46 +02:00
Mike Degatano
4b1a500956
Data disk APIs use UDisks2 info ( #1727 )
2023-03-27 12:09:31 -04:00
Peter Harris
d554f5f3af
Update websocket.md ( #1702 )
...
Removes section on camera_thumbnail and media_player_thumbnail, they were removed in this PR: https://github.com/home-assistant/core/pull/75452
2023-03-05 21:27:53 -05:00
Stefan Agner
fa73df9110
Document host_uts add-on support ( #1310 )
2023-02-13 14:41:41 +01:00
