jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-25 02:07:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Minor clean up edits to RESTful docs (#24316)

Browse Source
This commit is contained in:
krazos 2022-10-03 05:49:30 -04:00 committed by GitHub
parent e56374bccd
commit 5eb472002e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
source/_integrations/rest.markdown
View File

@ -1,6 +1,6 @@
--- ---
title: RESTful title: "RESTful"
description: Instructions on how to set up rest sensors within Home Assistant. description: "Instructions on how to integrate REST sensors and binary sensors into Home Assistant."
ha_category: ha_category:
- Binary Sensor - Binary Sensor
- Sensor - Sensor
@ -17,7 +17,7 @@ ha_integration_type: integration
The `rest` sensor platform is consuming a given endpoint which is exposed by a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer) of a device, an application, or a web service. The sensor has support for GET and POST requests. The `rest` sensor platform is consuming a given endpoint which is exposed by a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer) of a device, an application, or a web service. The sensor has support for GET and POST requests.
[RESTful Sensor](/integrations/sensor.rest) and [RESTful Binary_sensor](/integrations/binary_sensor.rest) can also be set up as platforms if there is only a single sensor per endpoint. [RESTful Sensor](/integrations/sensor.rest) and [RESTful Binary Sensor](/integrations/binary_sensor.rest) can also be set up as platforms if there is only a single sensor per endpoint.
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -163,11 +163,11 @@ scan_interval:
type: integer type: integer
default: 30 default: 30
sensor: sensor:
description: A list of [RESTful Sensor](/integrations/sensor.rest) to create from the shared data. All configuration settings that the supported by [RESTful Sensor](/integrations/sensor.rest#configuration-variables) not listed above can be used here. description: A list of sensors to create from the shared data. All configuration settings that are supported by [RESTful Sensor](/integrations/sensor.rest#configuration-variables) not listed above can be used here.
required: false required: false
type: list type: list
binary_sensor: binary_sensor:
description: A list of [RESTful Binary_sensor](/integrations/binary_sensor.rest) to create from the shared data All configuration settings that the supported by [RESTful Binary_sensor](/integrations/binary_sensor.rest#configuration-variables) not listed above can be used here. description: A list of binary sensors to create from the shared data. All configuration settings that are supported by [RESTful Binary Sensor](/integrations/binary_sensor.rest#configuration-variables) not listed above can be used here.
required: false required: false
type: list type: list
{% endconfiguration %} {% endconfiguration %}