Skip to content

Commit

Permalink
init
Browse files Browse the repository at this point in the history
  • Loading branch information
RFDarter committed Oct 2, 2024
1 parent df96b67 commit c40b4f7
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions web-api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@ to ``VERY_VERBOSE`` and check the ``object_id:`` in the logs.
By creating a simple GET request for a URL of the form ``/<domain>/<id>`` you will get a JSON payload
describing the current state of the component. This payload is equivalent to the ones sent by the
event source API.
You can get verbose information about the component by adding the parameter ``detail=all``
An example would be ``/select/my_select?detail=all``

To actually *control* the state of a component you need to send a POST request with a ``method`` like
``turn_on``. For example, to turn on a light, you would send a POST request to
Expand Down

0 comments on commit c40b4f7

Please sign in to comment.