8000 Trivial fix to Cloud IoT URL. (#1302) · johnmanong/python-docs-samples@fb0da4c · GitHub
[go: up one dir, main page]
Skip to content

Commit fb0da4c

Browse files
postmastersJon Wayne Parrott
postmasters
authored and
Jon Wayne Parrott
committed
Trivial fix to Cloud IoT URL. (GoogleCloudPlatform#1302)
1 parent 4bf348f commit fb0da4c

File tree

7 files changed

+42
-36
lines changed

7 files changed

+42
-36
lines changed

‎iot/api-client/end_to_end_example/README.rst.in

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# This file is used to generate README.rst
22

33
product:
4-
name: Google Cloud IoT Core API
4+
name: Google Cloud IoT Core
55
short_name: Cloud IoT Core
66
url: https://cloud.google.com/iot/docs
77
description: >
@@ -10,8 +10,8 @@ product:
1010
authorization.
1111

1212
Before you run the sample, you must retrieve the Google root certificate.
13-
For example, `wget https://pki.goog/roots.pem` or
14-
`curl https://pki.goog/roots.pem > roots.pem`.
13+
For example, ``wget https://pki.goog/roots.pem`` or
14+
``curl https://pki.goog/roots.pem > roots.pem``.
1515

1616
setup:
1717
- auth

‎iot/api-client/http_example/README.rst.in

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# This file is used to generate README.rst
22

33
product:
4-
name: Google Cloud IoT Core API
4+
name: Google Cloud IoT Core
55
short_name: Cloud IoT Core
66
url: https://cloud.google.com/iot/docs
77
description: >
88
`Google Cloud IoT Core`_ allows developers to easily integrate Publish and
99
Subscribe functionality with devices and programmatically manage device
1010
authorization.
1111

12-
The following example runs the sample using the project ID `blue-jet-123`
13-
and the device name `my-python-device`:
12+
The following example runs the sample using the project ID ``blue-jet-123``
13+
and the device name ``my-python-device``::
1414

1515
python cloudiot_http_example.py \
1616
--registry_id=my-registry \
@@ -30,4 +30,4 @@ samples:
3030

3131
cloud_client_library: false
3232

33-
folder: iot/api-client/http_example
33+
folder: iot/api-client/http_example

‎iot/api-client/manager/README.rst

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
.. This file is automatically generated. Do not edit this file directly.
22
3-
Google Cloud IoT Core API Python Samples
3+
Google Cloud IoT Core Python Samples
44
===============================================================================
55

66
.. image:: https://gstatic.com/cloudssh/images/open-btn.png
77
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=iot/api-client/manager/README.rst
88

99

10-
This directory contains samples for Google Cloud IoT Core API. `Google Cloud IoT Core`_ allows developers to easily integrate Publish and Subscribe functionality with devices and programmatically manage device authorization.
10+
This directory contains samples for Google Cloud IoT Core. `Google Cloud IoT Core`_ allows developers to easily integrate Publish and Subscribe functionality with devices and programmatically manage device authorization.
1111

1212

1313

1414

15-
.. _Google Cloud IoT Core API: https://cloud.google.com/vision/docs
15+
.. _Google Cloud IoT Core: https://cloud.google.com/iot/docs
1616

1717
Setup
1818
-------------------------------------------------------------------------------
@@ -70,13 +70,15 @@ To run this sample:
7070
7171
$ python manager.py
7272
73-
usage: manager.py [-h] --pubsub_topic PUBSUB_TOPIC [--project_id PROJECT_ID]
73+
usage: manager.py [-h] --pubsub_topic PUBSUB_TOPIC
74+
[--cloud_region CLOUD_REGION] [--config CONFIG]
75+
[--device_id DEVICE_ID]
7476
[--ec_public_key_file EC_PUBLIC_KEY_FILE]
77+
[--project_id PROJECT_ID] [--registry_id REGISTRY_ID]
7578
[--rsa_certificate_file RSA_CERTIFICATE_FILE]
76-
[--cloud_region CLOUD_REGION]
7779
[--service_account_json SERVICE_ACCOUNT_JSON]
78-
[--registry_id REGISTRY_ID] [--device_id DEVICE_ID]
79-
{create-es256,create-registry,create-rsa256,create-topic,create-unauth,delete-device,delete-registry,get,get-registry,get-state,list,list-registries,patch-es256,patch-rs256}
80+
[--version VERSION]
81+
{create-es256,create-registry,create-rsa256,create-topic,create-unauth,delete-device,delete-registry,get,get-registry,get-state,list,list-registries,patch-es256,patch-rs256,set-config}
8082
...
8183
8284
Example of using the Google Cloud IoT Core device manager to administer
@@ -93,7 +95,7 @@ To run this sample:
9395
list
9496
9597
positional arguments:
96-
{create-es256,create-registry,create-rsa256,create-topic,create-unauth,delete-device,delete-registry,get,get-registry,get-state,list,list-registries,patch-es256,patch-rs256}
98+
{create-es256,create-registry,create-rsa256,create-topic,create-unauth,delete-device,delete-registry,get,get-registry,get-state,list,list-registries,patch-es256,patch-rs256,set-config}
9799
create-es256 Create a new device with the given id, using ES256 for
98100
authentication.
99101
create-registry Gets or creates a device registry.
@@ -113,26 +115,30 @@ To run this sample:
113115
device.
114116
patch-rs256 Patch the device to add an RSA256 public key to the
115117
device.
118+
set-config Patch the device to add an RSA256 public key to the
119+
device.
116120
117121
optional arguments:
118122
-h, --help show this help message and exit
119123
--pubsub_topic PUBSUB_TOPIC
120124
Google Cloud Pub/Sub topic. Format is
121125
projects/project_id/topics/topic-id
122-
--project_id PROJECT_ID
123-
GCP cloud project name.
126+
--cloud_region CLOUD_REGION
127+
GCP cloud region
128+
--config CONFIG Configuration sent to a device.
129+
--device_id DEVICE_ID
130+
Device id.
124131
--ec_public_key_file EC_PUBLIC_KEY_FILE
125132
Path to public ES256 key file.
133+
--project_id PROJECT_ID
134+
GCP cloud project name.
135+
--registry_id REGISTRY_ID
136+
Registry id. If not set, a name will be generated.
126137
--rsa_certificate_file RSA_CERTIFICATE_FILE
127138
Path to RS256 certificate file.
128-
--cloud_region CLOUD_REGION
129-
GCP cloud region
130139
--service_account_json SERVICE_ACCOUNT_JSON
131140
Path to service account json file.
132-
--registry_id REGISTRY_ID
133-
Registry id. If not set, a name will be generated.
134-
--device_id DEVICE_ID
135-
Device id.
141+
--version VERSION Version number for setting device configuration.
136142
137143
138144

‎iot/api-client/manager/README.rst.in

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# This file is used to generate README.rst
22

33
product:
4-
name: Google Cloud IoT Core API
4+
name: Google Cloud IoT Core
55
short_name: Cloud IoT Core
6-
url: https://cloud.google.com/vision/docs
6+
url: https://cloud.google.com/iot/docs
77
description: >
88
`Google Cloud IoT Core`_ allows developers to easily integrate Publish and
99
Subscribe functionality with devices and programmatically manage device
@@ -20,4 +20,4 @@ samples:
2020

2121
cloud_client_library: false
2222

23-
folder: iot/api-client/manager
23+
folder: iot/api-client/manager

‎iot/api-client/mqtt_example/README.rst.in

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# This file is used to generate README.rst
22

33
product:
4-
name: Google Cloud IoT Core API
4+
name: Google Cloud IoT Core
55
short_name: Cloud IoT Core
66
url: https://cloud.google.com/iot/docs
77
description: >
@@ -10,11 +10,11 @@ product:
1010
authorization.
1111

1212
Before you run the sample, you must retrieve the Google root certificate.
13-
For example, `wget https://pki.goog/roots.pem` or
14-
`curl https://pki.goog/roots.pem > roots.pem`.
13+
For example, ``wget https://pki.goog/roots.pem`` or
14+
``curl https://pki.goog/roots.pem > roots.pem``.
1515

16-
The following example runs the sample using the project ID `blue-jet-123`
17-
and the device name `my-python-device`:
16+
The following example runs the sample using the project ID ``blue-jet-123``
17+
and the device name ``my-python-device``::
1818

1919
python cloudiot_mqtt_example.py \
2020
--registry_id=my-registry \
@@ -33,4 +33,4 @@ samples:
3333

3434
cloud_client_library: false
3535

36-
folder: iot/api-client/mqtt_example
36+
folder: iot/api-client/mqtt_example

‎iot/api-client/scripts/README.rst.in

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
product:
44
name: Google Cloud IoT Core
55
short_name: Cloud IoT Core
6-
url: https://cloud.google.com/iot/
6+
url: https://cloud.google.com/iot/docs
77
description: >
88
`Google Cloud IoT Core`_ is a fully-managed, globally distributed solution
99
for managing devices and sending / receiving messages from devices. Set the
10-
`GOOGLE_CLOUD_PROJECT` environment variable and call the script with your
10+
``GOOGLE_CLOUD_PROJECT`` environment variable and call the script with your
1111
topic ID.
1212

1313
setup:
@@ -21,4 +21,4 @@ samples:
2121

2222
cloud_client_library: true
2323

24-
folder: iot/api-client/scripts
24+
folder: iot/api-client/scripts

‎scripts/readme-gen/templates/README.tmpl.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This directory contains samples for {{product.name}}. {{product.description}}
1313

1414
{{description}}
1515

16-
.. _{{product.name}}: {{product.url}}
16+
.. _{{product.name}}: {{product.url}}
1717

1818
{% if setup %}
1919
Setup

0 commit comments

Comments
 (0)
0