Home Assistant Unofficial Reference 2024.12.1
Variables
homeassistant.components.rest.schema Namespace Reference

Variables

dictionary BINARY_SENSOR_SCHEMA
 
 COMBINED_SCHEMA
 
 CONFIG_SCHEMA
 
dictionary RESOURCE_SCHEMA
 
dictionary SENSOR_SCHEMA
 

Detailed Description

The rest component schemas.

Variable Documentation

◆ BINARY_SENSOR_SCHEMA

dictionary homeassistant.components.rest.schema.BINARY_SENSOR_SCHEMA
Initial value:
1 = {
2  **TEMPLATE_ENTITY_BASE_SCHEMA.schema,
3  vol.Optional(CONF_DEVICE_CLASS): BINARY_SENSOR_DEVICE_CLASSES_SCHEMA,
4  vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
5  vol.Optional(CONF_FORCE_UPDATE, default=DEFAULT_FORCE_UPDATE): cv.boolean,
6  vol.Optional(CONF_AVAILABILITY): cv.template,
7 }

Definition at line 84 of file schema.py.

◆ COMBINED_SCHEMA

homeassistant.components.rest.schema.COMBINED_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Optional(CONF_SCAN_INTERVAL): cv.time_period,
4  **RESOURCE_SCHEMA,
5  vol.Optional(SENSOR_DOMAIN): vol.All(
6  cv.ensure_list, [vol.Schema(SENSOR_SCHEMA)]
7  ),
8  vol.Optional(BINARY_SENSOR_DOMAIN): vol.All(
9  cv.ensure_list, [vol.Schema(BINARY_SENSOR_SCHEMA)]
10  ),
11  }
12 )

Definition at line 93 of file schema.py.

◆ CONFIG_SCHEMA

homeassistant.components.rest.schema.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  DOMAIN: vol.All(
4  cv.ensure_list,
5  cv.remove_falsy,
6  [COMBINED_SCHEMA],
7  )
8  },
9  extra=vol.ALLOW_EXTRA,
10 )

Definition at line 106 of file schema.py.

◆ RESOURCE_SCHEMA

dictionary homeassistant.components.rest.schema.RESOURCE_SCHEMA
Initial value:
1 = {
2  vol.Exclusive(CONF_RESOURCE, CONF_RESOURCE): cv.url,
3  vol.Exclusive(CONF_RESOURCE_TEMPLATE, CONF_RESOURCE): cv.template,
4  vol.Optional(CONF_AUTHENTICATION): vol.In(
5  [HTTP_BASIC_AUTHENTICATION, HTTP_DIGEST_AUTHENTICATION]
6  ),
7  vol.Optional(CONF_HEADERS): vol.Schema({cv.string: cv.template}),
8  vol.Optional(CONF_PARAMS): vol.Schema({cv.string: cv.template}),
9  vol.Optional(CONF_METHOD, default=DEFAULT_METHOD): vol.In(METHODS),
10  vol.Optional(CONF_USERNAME): cv.string,
11  vol.Optional(CONF_PASSWORD): cv.string,
12  vol.Exclusive(CONF_PAYLOAD, CONF_PAYLOAD): cv.string,
13  vol.Exclusive(CONF_PAYLOAD_TEMPLATE, CONF_PAYLOAD): cv.template,
14  vol.Optional(CONF_VERIFY_SSL, default=DEFAULT_VERIFY_SSL): cv.boolean,
15  vol.Optional(
16  CONF_SSL_CIPHER_LIST,
17  default=DEFAULT_SSL_CIPHER_LIST,
18  ): vol.In([e.value for e in SSLCipherList]),
19  vol.Optional(CONF_TIMEOUT, default=DEFAULT_TIMEOUT): cv.positive_int,
20  vol.Optional(CONF_ENCODING, default=DEFAULT_ENCODING): cv.string,
21 }

Definition at line 53 of file schema.py.

◆ SENSOR_SCHEMA

dictionary homeassistant.components.rest.schema.SENSOR_SCHEMA
Initial value:
1 = {
2  **TEMPLATE_SENSOR_BASE_SCHEMA.schema,
3  vol.Optional(CONF_JSON_ATTRS, default=[]): cv.ensure_list_csv,
4  vol.Optional(CONF_JSON_ATTRS_PATH): cv.string,
5  vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
6  vol.Optional(CONF_FORCE_UPDATE, default=DEFAULT_FORCE_UPDATE): cv.boolean,
7  vol.Optional(CONF_AVAILABILITY): cv.template,
8 }

Definition at line 75 of file schema.py.