Fix & improve documentation for Garadget integration variables (#15652)

This commit is contained in:
Greg Barker 2020-11-16 04:44:45 -08:00 committed by GitHub
parent ffbc0bbdbe
commit 82c34a519e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -37,33 +37,30 @@ covers:
description: List of your doors.
required: true
type: list
covers:
keys:
device:
description: This is the device id from your Garadget portal.
required: true
type: string
username:
description: Your Garadget account username.
required: true
type: string
password:
description: Your Garadget account password.
required: true
type: string
access_token:
description: A generated `access_token` from your Garadget account.
required: true
type: string
name:
description: me to use in the frontend, will use name configured in Garadget otherwise.
required: false
default: Garadget
type: string
keys:
device:
description: This is the device id from your Garadget portal. It can be found in the Settings section of the Garadget website or mobile application.
required: true
type: string
username:
description: Your Garadget account username. Use with `password` to obtain the `access_token` automatically.
required: false
type: string
password:
description: Your Garadget account password. Use with `username` to obtain the `access_token` automatically.
required: false
type: string
access_token:
description: A generated `access_token` from your Garadget account. To obtain an `access_token`, use the network tab of the developer tools for your web browser while logged into the Garadget website. When supplied, the `username` and `password` values are not required.
required: false
type: string
name:
description: Name to use in the frontend, will use name configured in Garadget otherwise.
required: false
default: Garadget
type: string
{% endconfiguration %}
If provided, the **access_token** will be used, otherwise the **username** and **password** will be used to automatically generate an access token at start time.
## Example
<p class='img'>