Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2025-03-01 03:51:36 +01:00
Code Issues Projects Releases Wiki Activity

Add documentation for the new selecy entity detail query parameter (#3257)

Browse Source 
Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
This commit is contained in:
Daniel Baulig 2023-10-11 18:55:05 -07:00 committed by GitHub
parent c1ec3cbea7
commit e88cd78ee8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
web-api/index.rst
View File

@ -268,6 +268,22 @@ a GET request to ``/select/house_mode`` could yield this payload:
"value": "party"
}
The detail parameter can be used to include available options in the response:
- **detail**: Set to ``all`` to include a list of available options.
For example GET ``/select/house_mode?detail=all`` could yield this payload:
.. code-block:: json
{
"id": "select-house_mode",
"name": "House Mode",
"state": "party",
"value": "party",
"option": ["party","sleep","relax","home","away"]
}
POST requests on the other hand allow setting the select, the available
method is ``set``. The following parameter can be used: