jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-11-14 13:30:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
2,710 Commits 49 Branches 0 Tags
ee3c670e5f9c93e88f6b43c25f90ef56ca9860bf
Commit Graph

178 Commits

Author SHA1 Message Date
Stefan Weil
16b9e46caf Fix some typos in documentation (found by codespell) (#2837) 
Signed-off-by: Stefan Weil <sw@weilnetz.de>
 2025-10-18 16:44:32 +02:00
Abílio Costa
202f37df46 Add docs for extract_from_target websocket api (#2749) 2025-10-14 18:12:10 +01:00
Jan Čermák
5939db004b Add docs for new .../logs/latest Supervisor API endpoints (#2785) 2025-09-16 12:57:03 +02:00
Mike Degatano
8d1ab35949 Add extra field to jobs, clean up jobs API and add placeholders (#2776) 2025-09-12 20:42:48 +02:00
Mike Degatano
24f8673968 Document stage field for job errors (#2782) 2025-09-12 20:40:02 +02:00
Daniel O'Connor
080c248ab7 REST API: Add basic documentation of components API call (#2658) 2025-09-12 20:21:09 +02:00
Mike Degatano
615f3b02ff Document background addon install/update option (#2775) 2025-09-12 20:20:03 +02:00
Felipe Santos
5ff9d97160 Document rebuilding addons with force (#2718) 2025-09-12 20:16:46 +02:00
Mike Degatano
119d4dffab Fix documentation gaps in /host/info API (#2780) 2025-09-09 17:06:25 +02:00
Mike Degatano
a114bd0639 Add dev only note to version in /supervisor/update (#2779) 2025-09-08 18:08:12 -04:00
Mike Degatano
98777585a4 Document query parameters for host logs APIs (#2781) 2025-09-08 18:06:57 -04:00
Mike Degatano
2845c42296 Document Supervisor's add-on availability api (#2769) 2025-09-04 17:34:01 -04:00
David Rapan
9bae076785 Add documentation for IPv6 address generation mode & privacy extensions (#2670) 2025-09-01 15:21:49 +02:00
David Rapan
bc3e175771 Add documentation for opt-in IPv6 for containers (#2677) 2025-09-01 15:21:07 +02:00
Mike Degatano
26358ac087 Document Supervisor's detect_blocking_io option (#2761) 2025-08-22 10:37:22 +02:00
Petar Petrov
adecee9951 Add disk usage endpoint to supervisor (#2750) 2025-08-20 09:14:48 +02:00
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