123 Commits

Author SHA1 Message Date
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
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
Sven Serlier
b163e1048d
Rename component to integration (#1345) 2022-05-30 11:47:48 +02:00
Paulus Schoutsen
ab9f007804
Update mobile app (#1325)
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
2022-05-17 09:05:52 -07:00
Matej Drobnič
8e7cd6d474
Update calendar event rest AP with description and location (#1332)
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
2022-05-15 20:33:38 +02:00
Allen Porter
57cddc14bb
Add documentation for the existing calendar rest APIs (#1330) 2022-05-14 23:14:53 -07: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
Nemec
c16a08f770
Clarify when an encrypted request has no data (#1304) 2022-04-25 15:11:24 -07:00
Sebastian Höffner
510d7c38d5
Correct /api/intent/handle endpoint route, add intent: hint (#1305) 2022-04-24 21:45:25 -07:00
Mike Degatano
060292b0b4
Add llmnr and mdns fields to API doc (#1286) 2022-04-11 19:29:12 +02:00
J. Nick Koston
1580b118a2
Document no_attributes flag for history api (#1242)
Co-authored-by: Teemu R. <tpr@iki.fi>
2022-03-23 10:30:04 +01:00
Joakim Sørensen
d06b791272
Add homeassistant to partial backup endpoint (#1225) 2022-02-23 08:58:34 -08:00
Paulus Schoutsen
ddd3c9f683
Document validate_config (#1223) 2022-02-22 13:34:34 -08:00
Andrew Soback
573610c70d
Added intent handle api endpoint (#1210) 2022-02-09 23:30:35 -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
Paulus Schoutsen
5ef105e921
Document native app websocket push (#1172)
Co-authored-by: Franck Nijhof <git@frenck.dev>
Co-authored-by: Justin Bassett <bassett.justint@gmail.com>
2022-01-31 15:02:14 -08:00
Ashley Cawley
ccf6b4f438
Added Python Example (#1143) 2022-01-24 13:55:36 +01:00
Paulus Schoutsen
938ee76929
Document delivering webhooks over WS (#1180) 2022-01-24 13:52:57 +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
Nico Müller
1078ce5f98
Add documentation for 'fire_event' command in websocket api (#1174) 2022-01-18 11:12:25 -08:00
DJJo14
1a6a7b090d
Document Subscribe to trigger websocket (#1182)
Co-authored-by: Paulus Schoutsen <paulus@home-assistant.io>
2022-01-09 23:40:51 -08:00