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-18 23:06:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Nest config snippet to reference Subscription Name, not Subscription ID (#15741)

Browse Source 
* Update Nest config snippet

The current sample yaml for the Nest SDM API asks users to supply subscriber_id as per "Subscription ID in Google Cloud Console".

This is potentially ambiguous - should they provide the Subscription ID, or just replace the last part of the dummy value with it? Users could incorporate "Subscription ID" as show in the console and craft the full path by hand, but they would also need to fill in the missing project ID (represented in the example yaml as '...'). To add to the confusion, the GCP project ID they would need to supply midway through this full path is different to the Device Access Console project_id they have just provided in the previous yaml parameter.

We can simplify this significantly by removing references to "Subscription ID" and just telling users to use the value under "Subscription name" in the same table - this is the fully qualified path which HA really wants. 

Screenshot here for clarity: https://i.imgur.com/on39AtX.png

* Update nest.markdown

Description needs to stay on a single line.
This commit is contained in:
Sam 2020-11-25 08:28:09 +11:00 committed by GitHub
parent 1998833fcd
commit fb3b6546d8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
source/_integrations/nest.markdown
View File

@ -80,8 +80,10 @@ When you get to the steps about configuring events make sure to follow guide und
nest:
client_id: CLIENT_ID
client_secret: CLIENT_SECRET
project_id: PROJECT_ID # ("Project ID" in the Device Access Console)
subscriber_id: projects/.../subscriptions/SUBSCRIBER_ID # ("Subscription ID" in Google Cloud Console. Replace with full path.)
# "Project ID" in the Device Access Console
project_id: PROJECT_ID
# Provide the full path exactly as shown under "Subscription name" in Google Cloud Console
subscriber_id: projects/project-label-22ee1/subscriptions/SUBSCRIBER_ID
```
{% configuration %}
@ -98,7 +100,7 @@ project_id:
required: false
type: string
subscriber_id:
description: Full path for the Pub/sub Subscription ID used to receive events. This is required to use the SDM API.
description: Full path for the Pub/sub Subscription ID used to receive events. This is required to use the SDM API. Enter this exactly as it appers under "Subscription name" in the [Pub/Sub console](https://console.cloud.google.com/cloudpubsub/subscription/list).
type: string
required: false
{% endconfiguration %}