148 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
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
Björn Stenberg
8d1a03d738
Update REST API documentation (#1677)
- Remove superflous -X parameter from curl command lines. See the curl
  author's explanation for more detail about this:
  https://daniel.haxx.se/blog/2015/09/11/unnecessary-use-of-curl-x/

- Quote all URLs containing wildcard characters.

- Make example command-lines consistent

- Replace "ABCDEFGH" token placeholder with a more clear "TOKEN".
2023-02-10 10:14:46 -05:00
yetsea
c7befc2a34
Update websocket.md (#1662)
Remove the extra comma in the provided example. The extra comma would make json parsing to fail.
2023-02-02 20:35:11 -05:00
Alex Bergsland
a1956e5ee1
Update rest.md (#1656) 2023-01-30 16:37:48 +01:00
Paulus Schoutsen
6f43b97d14 Fix conversation_process 2023-01-19 14:01:17 -05:00
Paulus Schoutsen
052b4d55a3
Document the mobile app webhook for conversation (#1637) 2023-01-19 13:59:19 -05:00
Tarmo
7a4f541851
Update rest.md, fix inconsistent example for API CURL (#1595) 2022-12-28 23:42:49 +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
Dave T
6f39adbafe
Update formatting and grammar in REST API docs (#1495)
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
Co-authored-by: Franck Nijhof <git@frenck.dev>
2022-10-14 12:59:39 +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