diff --git a/cmd/scw/testdata/test-all-usage-iot-device-create-usage.golden b/cmd/scw/testdata/test-all-usage-iot-device-create-usage.golden index 79dae73d04..acb1e12698 100644 --- a/cmd/scw/testdata/test-all-usage-iot-device-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iot-device-create-usage.golden @@ -1,15 +1,15 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Add a device. +Attach a device to a given Hub. USAGE: scw iot device create [arg=value ...] ARGS: name= Device name - hub-id ID of the device's hub - [allow-insecure] Allow plain and server-authenticated SSL connections in addition to mutually-authenticated ones - [allow-multiple-connections] Allow multiple physical devices to connect with this device's credentials + hub-id Hub ID of the device + [allow-insecure] Defines whether to allow plain and server-authenticated SSL connections in addition to mutually-authenticated ones + [allow-multiple-connections] Defines whether to allow multiple physical devices to connect with this device's credentials [message-filters.publish.policy] How to use the topic list (unknown | accept | reject) [message-filters.publish.topics.{index}] List of topics to accept or reject. It must be valid MQTT topics and up to 65535 characters [message-filters.subscribe.policy] How to use the topic list (unknown | accept | reject) diff --git a/cmd/scw/testdata/test-all-usage-iot-device-delete-usage.golden b/cmd/scw/testdata/test-all-usage-iot-device-delete-usage.golden index 75c601482e..22d3242b4e 100644 --- a/cmd/scw/testdata/test-all-usage-iot-device-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iot-device-delete-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Remove a device. +Remove a specific device from the specific Hub it is attached to. USAGE: scw iot device delete [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-iot-device-disable-usage.golden b/cmd/scw/testdata/test-all-usage-iot-device-disable-usage.golden index 155a0f6f79..8639a3edf5 100644 --- a/cmd/scw/testdata/test-all-usage-iot-device-disable-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iot-device-disable-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Disable a device. +Disable an existing device, specified by its device ID. USAGE: scw iot device disable [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-iot-device-enable-usage.golden b/cmd/scw/testdata/test-all-usage-iot-device-enable-usage.golden index 7978c838b7..93a1582b0e 100644 --- a/cmd/scw/testdata/test-all-usage-iot-device-enable-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iot-device-enable-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Enable a device. +Enable a specific device, specified by its device ID. USAGE: scw iot device enable [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-iot-device-get-certificate-usage.golden b/cmd/scw/testdata/test-all-usage-iot-device-get-certificate-usage.golden index 07f3c0c08c..616fc8a960 100644 --- a/cmd/scw/testdata/test-all-usage-iot-device-get-certificate-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iot-device-get-certificate-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get a device's certificate. +Get information for a particular PEM-encoded certificate, specified by the device ID. The response returns full details of the device, including its type of certificate. USAGE: scw iot device get-certificate [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-iot-device-get-usage.golden b/cmd/scw/testdata/test-all-usage-iot-device-get-usage.golden index 288efe9ebc..59b3894982 100644 --- a/cmd/scw/testdata/test-all-usage-iot-device-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iot-device-get-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get a device. +Retrieve information about an existing device, specified by its device ID. Its full details, including name, status and ID, are returned in the response object. USAGE: scw iot device get [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-iot-device-list-usage.golden b/cmd/scw/testdata/test-all-usage-iot-device-list-usage.golden index 33249fee2b..facf4f6e80 100644 --- a/cmd/scw/testdata/test-all-usage-iot-device-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iot-device-list-usage.golden @@ -1,15 +1,15 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List devices. +List all devices in the specified region. By default, returned devices are ordered by creation date in ascending order, though this can be modified via the `order_by` field. USAGE: scw iot device list [arg=value ...] ARGS: [order-by] Ordering of requested devices (name_asc | name_desc | status_asc | status_desc | hub_id_asc | hub_id_desc | created_at_asc | created_at_desc | updated_at_asc | updated_at_desc | allow_insecure_asc | allow_insecure_desc) - [name] Filter on the name - [hub-id] Filter on the hub - [allow-insecure] Filter on the allow_insecure flag + [name] Name to filter for, only devices with this name will be returned + [hub-id] Hub ID to filter for, only devices attached to this Hub will be returned + [allow-insecure] Defines wheter to filter the allow_insecure flag [status] Device status (enabled, disabled, etc.) (unknown | error | enabled | disabled) [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | all) diff --git a/cmd/scw/testdata/test-all-usage-iot-device-renew-certificate-usage.golden b/cmd/scw/testdata/test-all-usage-iot-device-renew-certificate-usage.golden index e71a566229..17c9d0841f 100644 --- a/cmd/scw/testdata/test-all-usage-iot-device-renew-certificate-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iot-device-renew-certificate-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Renew a device certificate. +Renew the certificate of an existing device, specified by its device ID. USAGE: scw iot device renew-certificate [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-iot-device-set-certificate-usage.golden b/cmd/scw/testdata/test-all-usage-iot-device-set-certificate-usage.golden index 38aaccaa99..5095d00a91 100644 --- a/cmd/scw/testdata/test-all-usage-iot-device-set-certificate-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iot-device-set-certificate-usage.golden @@ -1,13 +1,13 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Set a custom certificate on a device. +Switch the existing certificate of a given device with an EM-encoded custom certificate. USAGE: scw iot device set-certificate [arg=value ...] ARGS: device-id Device ID - certificate-pem The PEM-encoded custom certificate + certificate-pem PEM-encoded custom certificate [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-iot-device-update-usage.golden b/cmd/scw/testdata/test-all-usage-iot-device-update-usage.golden index 29b761e4d5..d6a163c061 100644 --- a/cmd/scw/testdata/test-all-usage-iot-device-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iot-device-update-usage.golden @@ -1,15 +1,15 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Update a device. +Update the parameters of an existing device, specified by its device ID. USAGE: scw iot device update [arg=value ...] ARGS: device-id Device ID - [description] Device description - [allow-insecure] Allow plain and server-authenticated SSL connections in addition to mutually-authenticated ones - [allow-multiple-connections] Allow multiple physical devices to connect with this device's credentials + [description] Description for the device + [allow-insecure] Defines whether to allow plain and server-authenticated SSL connections in addition to mutually-authenticated ones + [allow-multiple-connections] Defines whether to allow multiple physical devices to connect with this device's credentials [message-filters.publish.policy] How to use the topic list (unknown | accept | reject) [message-filters.publish.topics.{index}] List of topics to accept or reject. It must be valid MQTT topics and up to 65535 characters [message-filters.subscribe.policy] How to use the topic list (unknown | accept | reject) diff --git a/cmd/scw/testdata/test-all-usage-iot-hub-create-usage.golden b/cmd/scw/testdata/test-all-usage-iot-hub-create-usage.golden index 3e28844873..1132f77a1f 100644 --- a/cmd/scw/testdata/test-all-usage-iot-hub-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iot-hub-create-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create a hub. +Create a new Hub in the targeted region, specifying its configuration including name and product plan. USAGE: scw iot hub create [arg=value ...] @@ -8,9 +8,9 @@ USAGE: ARGS: name= Hub name (up to 255 characters) [project-id] Project ID to use. If none is passed the default project ID will be used - product-plan=plan_shared Hub feature set (plan_unknown | plan_shared | plan_dedicated | plan_ha) + product-plan=plan_shared Hub product plan (plan_unknown | plan_shared | plan_dedicated | plan_ha) [disable-events] Disable Hub events - [events-topic-prefix] Hub events topic prefix (default '$SCW/events') + [events-topic-prefix] Topic prefix (default '$SCW/events') of Hub events [twins-graphite-config.push-uri] [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par) diff --git a/cmd/scw/testdata/test-all-usage-iot-hub-delete-usage.golden b/cmd/scw/testdata/test-all-usage-iot-hub-delete-usage.golden index 52a709ca8e..77504d0f03 100644 --- a/cmd/scw/testdata/test-all-usage-iot-hub-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iot-hub-delete-usage.golden @@ -1,13 +1,13 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete a hub. +Delete an existing IoT Hub, specified by its Hub ID. Deleting a Hub is permanent, and cannot be undone. USAGE: scw iot hub delete [arg=value ...] ARGS: hub-id Hub ID - [delete-devices] Force deletion of devices added to this hub instead of rejecting operation + [delete-devices] Defines whether to force the deletion of devices added to this Hub or reject the operation [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-iot-hub-disable-usage.golden b/cmd/scw/testdata/test-all-usage-iot-hub-disable-usage.golden index b496d7350b..3d0c608d01 100644 --- a/cmd/scw/testdata/test-all-usage-iot-hub-disable-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iot-hub-disable-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Disable a hub. +Disable an existing IoT Hub, specified by its Hub ID. USAGE: scw iot hub disable [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-iot-hub-enable-usage.golden b/cmd/scw/testdata/test-all-usage-iot-hub-enable-usage.golden index b9b33533a6..afac76746f 100644 --- a/cmd/scw/testdata/test-all-usage-iot-hub-enable-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iot-hub-enable-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Enable a hub. +Enable an existing IoT Hub, specified by its Hub ID. USAGE: scw iot hub enable [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-iot-hub-get-ca-usage.golden b/cmd/scw/testdata/test-all-usage-iot-hub-get-ca-usage.golden index 49811721dd..b662b001bc 100644 --- a/cmd/scw/testdata/test-all-usage-iot-hub-get-ca-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iot-hub-get-ca-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get the certificate authority of a hub. +Get information for a particular PEM-encoded certificate, specified by the Hub ID. USAGE: scw iot hub get-ca [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-iot-hub-get-usage.golden b/cmd/scw/testdata/test-all-usage-iot-hub-get-usage.golden index 168ad85dda..b88b216466 100644 --- a/cmd/scw/testdata/test-all-usage-iot-hub-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iot-hub-get-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get a hub. +Retrieve information about an existing IoT Hub, specified by its Hub ID. Its full details, including name, status and endpoint, are returned in the response object. USAGE: scw iot hub get [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-iot-hub-list-usage.golden b/cmd/scw/testdata/test-all-usage-iot-hub-list-usage.golden index 0652abb915..abdc656f2c 100644 --- a/cmd/scw/testdata/test-all-usage-iot-hub-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iot-hub-list-usage.golden @@ -1,15 +1,15 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List hubs. +List all Hubs in the specified zone. By default, returned Hubs are ordered by creation date in ascending order, though this can be modified via the `order_by` field. USAGE: scw iot hub list [arg=value ...] ARGS: - [order-by] Ordering of requested hub (name_asc | name_desc | status_asc | status_desc | product_plan_asc | product_plan_desc | created_at_asc | created_at_desc | updated_at_asc | updated_at_desc) - [project-id] Filter on project - [name] Filter on the name - [organization-id] Filter on the organization + [order-by] Sort order of Hubs in the response (name_asc | name_desc | status_asc | status_desc | product_plan_asc | product_plan_desc | created_at_asc | created_at_desc | updated_at_asc | updated_at_desc) + [project-id] Only list Hubs of this Project ID + [name] Hub name + [organization-id] Only list Hubs of this Organization ID [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | all) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-iot-hub-set-ca-usage.golden b/cmd/scw/testdata/test-all-usage-iot-hub-set-ca-usage.golden index 3317aa3323..212b6b07d6 100644 --- a/cmd/scw/testdata/test-all-usage-iot-hub-set-ca-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iot-hub-set-ca-usage.golden @@ -1,14 +1,14 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Set the certificate authority of a hub. +Set a particular PEM-encoded certificate, specified by the Hub ID. USAGE: scw iot hub set-ca [arg=value ...] ARGS: hub-id Hub ID - ca-cert-pem The CA's PEM-encoded certificate - challenge-cert-pem Proof of possession PEM-encoded certificate + ca-cert-pem CA's PEM-encoded certificate + challenge-cert-pem Proof of possession of PEM-encoded certificate [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-iot-hub-update-usage.golden b/cmd/scw/testdata/test-all-usage-iot-hub-update-usage.golden index a0134202ad..41b4a46db1 100644 --- a/cmd/scw/testdata/test-all-usage-iot-hub-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iot-hub-update-usage.golden @@ -1,16 +1,16 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Update a hub. +Update the parameters of an existing IoT Hub, specified by its Hub ID. USAGE: scw iot hub update [arg=value ...] ARGS: - hub-id Hub ID + hub-id ID of the Hub you want to update [name] Hub name (up to 255 characters) - [product-plan] Hub feature set (plan_unknown | plan_shared | plan_dedicated | plan_ha) + [product-plan] Hub product plan (plan_unknown | plan_shared | plan_dedicated | plan_ha) [disable-events] Disable Hub events - [events-topic-prefix] Hub events topic prefix + [events-topic-prefix] Topic prefix of Hub events [enable-device-auto-provisioning] Enable device auto provisioning [twins-graphite-config.push-uri] [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par) diff --git a/cmd/scw/testdata/test-all-usage-iot-network-list-usage.golden b/cmd/scw/testdata/test-all-usage-iot-network-list-usage.golden index 8963c925e7..ebbb691894 100644 --- a/cmd/scw/testdata/test-all-usage-iot-network-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iot-network-list-usage.golden @@ -7,9 +7,9 @@ USAGE: ARGS: [order-by] Ordering of requested routes (name_asc | name_desc | type_asc | type_desc | created_at_asc | created_at_desc) - [name] Filter on Network name - [hub-id] Filter on the hub - [topic-prefix] Filter on the topic prefix + [name] Network name to filter for + [hub-id] Hub ID to filter for + [topic-prefix] Topic prefix to filter for [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | all) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-iot-route-create-usage.golden b/cmd/scw/testdata/test-all-usage-iot-route-create-usage.golden index 57a55a60d7..8f288e48c7 100644 --- a/cmd/scw/testdata/test-all-usage-iot-route-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iot-route-create-usage.golden @@ -1,22 +1,22 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Multiple route kinds can be created: -- Database Route. +Multiple kinds of routes can be created, such as: +- Database Route Create a route that will record subscribed MQTT messages into your database. You need to manage the database by yourself. - REST Route. Create a route that will call a REST API on received subscribed MQTT messages. - S3 Routes. Create a route that will put subscribed MQTT messages into an S3 bucket. - You need to create the bucket yourself and grant us write access. - The grant can be done with s3cmd (`s3cmd setacl s3:// --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031`). + You need to create the bucket yourself and grant write access. + Granting can be done with s3cmd (`s3cmd setacl s3:// --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031`). USAGE: scw iot route create [arg=value ...] ARGS: [name=] Route name - [hub-id] ID of the route's hub + [hub-id] Hub ID of the route [topic] Topic the route subscribes to. It must be a valid MQTT topic and up to 65535 characters [s3-config.bucket-region] [s3-config.bucket-name] diff --git a/cmd/scw/testdata/test-all-usage-iot-route-delete-usage.golden b/cmd/scw/testdata/test-all-usage-iot-route-delete-usage.golden index 9259428896..606f5054d9 100644 --- a/cmd/scw/testdata/test-all-usage-iot-route-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iot-route-delete-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete a route. +Delete an existing route, specified by its route ID. Deleting a route is permanent, and cannot be undone. USAGE: scw iot route delete [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-iot-route-get-usage.golden b/cmd/scw/testdata/test-all-usage-iot-route-get-usage.golden index 8a9d1429aa..8f0cf9c089 100644 --- a/cmd/scw/testdata/test-all-usage-iot-route-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iot-route-get-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get a route. +Get information for a particular route, specified by the route ID. The response returns full details of the route, including its type, the topic it subscribes to and its configuration. USAGE: scw iot route get [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-iot-route-list-usage.golden b/cmd/scw/testdata/test-all-usage-iot-route-list-usage.golden index 62d503c128..e25245bc9d 100644 --- a/cmd/scw/testdata/test-all-usage-iot-route-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iot-route-list-usage.golden @@ -1,14 +1,14 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List routes. +List all routes in the specified region. By default, returned routes are ordered by creation date in ascending order, though this can be modified via the `order_by` field. USAGE: scw iot route list [arg=value ...] ARGS: [order-by] Ordering of requested routes (name_asc | name_desc | hub_id_asc | hub_id_desc | type_asc | type_desc | created_at_asc | created_at_desc) - [hub-id] Filter on the hub - [name] Filter on route's name + [hub-id] Hub ID to filter for + [name] Route name to filter for [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | all) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-iot-route-update-usage.golden b/cmd/scw/testdata/test-all-usage-iot-route-update-usage.golden index 761f9c894d..2fce171ca2 100644 --- a/cmd/scw/testdata/test-all-usage-iot-route-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iot-route-update-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Update a route. +Update the parameters of an existing route, specified by its route ID. USAGE: scw iot route update [arg=value ...] diff --git a/docs/commands/iot.md b/docs/commands/iot.md index 7c6a480418..fd6628fe67 100644 --- a/docs/commands/iot.md +++ b/docs/commands/iot.md @@ -44,7 +44,7 @@ IoT Device commands. ### Add a device -Add a device. +Attach a device to a given Hub. **Usage:** @@ -58,9 +58,9 @@ scw iot device create [arg=value ...] | Name | | Description | |------|---|-------------| | name | Required
Default: `` | Device name | -| hub-id | Required | ID of the device's hub | -| allow-insecure | | Allow plain and server-authenticated SSL connections in addition to mutually-authenticated ones | -| allow-multiple-connections | | Allow multiple physical devices to connect with this device's credentials | +| hub-id | Required | Hub ID of the device | +| allow-insecure | | Defines whether to allow plain and server-authenticated SSL connections in addition to mutually-authenticated ones | +| allow-multiple-connections | | Defines whether to allow multiple physical devices to connect with this device's credentials | | message-filters.publish.policy | One of: `unknown`, `accept`, `reject` | How to use the topic list | | message-filters.publish.topics.{index} | | List of topics to accept or reject. It must be valid MQTT topics and up to 65535 characters | | message-filters.subscribe.policy | One of: `unknown`, `accept`, `reject` | How to use the topic list | @@ -72,7 +72,7 @@ scw iot device create [arg=value ...] ### Remove a device -Remove a device. +Remove a specific device from the specific Hub it is attached to. **Usage:** @@ -92,7 +92,7 @@ scw iot device delete [arg=value ...] ### Disable a device -Disable a device. +Disable an existing device, specified by its device ID. **Usage:** @@ -112,7 +112,7 @@ scw iot device disable [arg=value ...] ### Enable a device -Enable a device. +Enable a specific device, specified by its device ID. **Usage:** @@ -132,7 +132,7 @@ scw iot device enable [arg=value ...] ### Get a device -Get a device. +Retrieve information about an existing device, specified by its device ID. Its full details, including name, status and ID, are returned in the response object. **Usage:** @@ -152,7 +152,7 @@ scw iot device get [arg=value ...] ### Get a device's certificate -Get a device's certificate. +Get information for a particular PEM-encoded certificate, specified by the device ID. The response returns full details of the device, including its type of certificate. **Usage:** @@ -193,7 +193,7 @@ scw iot device get-metrics [arg=value ...] ### List devices -List devices. +List all devices in the specified region. By default, returned devices are ordered by creation date in ascending order, though this can be modified via the `order_by` field. **Usage:** @@ -207,9 +207,9 @@ scw iot device list [arg=value ...] | Name | | Description | |------|---|-------------| | order-by | One of: `name_asc`, `name_desc`, `status_asc`, `status_desc`, `hub_id_asc`, `hub_id_desc`, `created_at_asc`, `created_at_desc`, `updated_at_asc`, `updated_at_desc`, `allow_insecure_asc`, `allow_insecure_desc` | Ordering of requested devices | -| name | | Filter on the name | -| hub-id | | Filter on the hub | -| allow-insecure | | Filter on the allow_insecure flag | +| name | | Name to filter for, only devices with this name will be returned | +| hub-id | | Hub ID to filter for, only devices attached to this Hub will be returned | +| allow-insecure | | Defines wheter to filter the allow_insecure flag | | status | One of: `unknown`, `error`, `enabled`, `disabled` | Device status (enabled, disabled, etc.) | | region | Default: `fr-par`
One of: `fr-par`, `all` | Region to target. If none is passed will use default region from the config | @@ -217,7 +217,7 @@ scw iot device list [arg=value ...] ### Renew a device certificate -Renew a device certificate. +Renew the certificate of an existing device, specified by its device ID. **Usage:** @@ -237,7 +237,7 @@ scw iot device renew-certificate [arg=value ...] ### Set a custom certificate on a device -Set a custom certificate on a device. +Switch the existing certificate of a given device with an EM-encoded custom certificate. **Usage:** @@ -251,14 +251,14 @@ scw iot device set-certificate [arg=value ...] | Name | | Description | |------|---|-------------| | device-id | Required | Device ID | -| certificate-pem | Required | The PEM-encoded custom certificate | +| certificate-pem | Required | PEM-encoded custom certificate | | region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | ### Update a device -Update a device. +Update the parameters of an existing device, specified by its device ID. **Usage:** @@ -272,9 +272,9 @@ scw iot device update [arg=value ...] | Name | | Description | |------|---|-------------| | device-id | Required | Device ID | -| description | | Device description | -| allow-insecure | | Allow plain and server-authenticated SSL connections in addition to mutually-authenticated ones | -| allow-multiple-connections | | Allow multiple physical devices to connect with this device's credentials | +| description | | Description for the device | +| allow-insecure | | Defines whether to allow plain and server-authenticated SSL connections in addition to mutually-authenticated ones | +| allow-multiple-connections | | Defines whether to allow multiple physical devices to connect with this device's credentials | | message-filters.publish.policy | One of: `unknown`, `accept`, `reject` | How to use the topic list | | message-filters.publish.topics.{index} | | List of topics to accept or reject. It must be valid MQTT topics and up to 65535 characters | | message-filters.subscribe.policy | One of: `unknown`, `accept`, `reject` | How to use the topic list | @@ -291,7 +291,7 @@ IoT Hub commands. ### Create a hub -Create a hub. +Create a new Hub in the targeted region, specifying its configuration including name and product plan. **Usage:** @@ -306,9 +306,9 @@ scw iot hub create [arg=value ...] |------|---|-------------| | name | Required
Default: `` | Hub name (up to 255 characters) | | project-id | | Project ID to use. If none is passed the default project ID will be used | -| product-plan | Required
Default: `plan_shared`
One of: `plan_unknown`, `plan_shared`, `plan_dedicated`, `plan_ha` | Hub feature set | +| product-plan | Required
Default: `plan_shared`
One of: `plan_unknown`, `plan_shared`, `plan_dedicated`, `plan_ha` | Hub product plan | | disable-events | | Disable Hub events | -| events-topic-prefix | | Hub events topic prefix (default '$SCW/events') | +| events-topic-prefix | | Topic prefix (default '$SCW/events') of Hub events | | twins-graphite-config.push-uri | | | | region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | @@ -316,7 +316,7 @@ scw iot hub create [arg=value ...] ### Delete a hub -Delete a hub. +Delete an existing IoT Hub, specified by its Hub ID. Deleting a Hub is permanent, and cannot be undone. **Usage:** @@ -330,14 +330,14 @@ scw iot hub delete [arg=value ...] | Name | | Description | |------|---|-------------| | hub-id | Required | Hub ID | -| delete-devices | | Force deletion of devices added to this hub instead of rejecting operation | +| delete-devices | | Defines whether to force the deletion of devices added to this Hub or reject the operation | | region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | ### Disable a hub -Disable a hub. +Disable an existing IoT Hub, specified by its Hub ID. **Usage:** @@ -357,7 +357,7 @@ scw iot hub disable [arg=value ...] ### Enable a hub -Enable a hub. +Enable an existing IoT Hub, specified by its Hub ID. **Usage:** @@ -377,7 +377,7 @@ scw iot hub enable [arg=value ...] ### Get a hub -Get a hub. +Retrieve information about an existing IoT Hub, specified by its Hub ID. Its full details, including name, status and endpoint, are returned in the response object. **Usage:** @@ -397,7 +397,7 @@ scw iot hub get [arg=value ...] ### Get the certificate authority of a hub -Get the certificate authority of a hub. +Get information for a particular PEM-encoded certificate, specified by the Hub ID. **Usage:** @@ -417,7 +417,7 @@ scw iot hub get-ca [arg=value ...] ### List hubs -List hubs. +List all Hubs in the specified zone. By default, returned Hubs are ordered by creation date in ascending order, though this can be modified via the `order_by` field. **Usage:** @@ -430,17 +430,17 @@ scw iot hub list [arg=value ...] | Name | | Description | |------|---|-------------| -| order-by | One of: `name_asc`, `name_desc`, `status_asc`, `status_desc`, `product_plan_asc`, `product_plan_desc`, `created_at_asc`, `created_at_desc`, `updated_at_asc`, `updated_at_desc` | Ordering of requested hub | -| project-id | | Filter on project | -| name | | Filter on the name | -| organization-id | | Filter on the organization | +| order-by | One of: `name_asc`, `name_desc`, `status_asc`, `status_desc`, `product_plan_asc`, `product_plan_desc`, `created_at_asc`, `created_at_desc`, `updated_at_asc`, `updated_at_desc` | Sort order of Hubs in the response | +| project-id | | Only list Hubs of this Project ID | +| name | | Hub name | +| organization-id | | Only list Hubs of this Organization ID | | region | Default: `fr-par`
One of: `fr-par`, `all` | Region to target. If none is passed will use default region from the config | ### Set the certificate authority of a hub -Set the certificate authority of a hub. +Set a particular PEM-encoded certificate, specified by the Hub ID. **Usage:** @@ -454,15 +454,15 @@ scw iot hub set-ca [arg=value ...] | Name | | Description | |------|---|-------------| | hub-id | Required | Hub ID | -| ca-cert-pem | Required | The CA's PEM-encoded certificate | -| challenge-cert-pem | Required | Proof of possession PEM-encoded certificate | +| ca-cert-pem | Required | CA's PEM-encoded certificate | +| challenge-cert-pem | Required | Proof of possession of PEM-encoded certificate | | region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | ### Update a hub -Update a hub. +Update the parameters of an existing IoT Hub, specified by its Hub ID. **Usage:** @@ -475,11 +475,11 @@ scw iot hub update [arg=value ...] | Name | | Description | |------|---|-------------| -| hub-id | Required | Hub ID | +| hub-id | Required | ID of the Hub you want to update | | name | | Hub name (up to 255 characters) | -| product-plan | One of: `plan_unknown`, `plan_shared`, `plan_dedicated`, `plan_ha` | Hub feature set | +| product-plan | One of: `plan_unknown`, `plan_shared`, `plan_dedicated`, `plan_ha` | Hub product plan | | disable-events | | Disable Hub events | -| events-topic-prefix | | Hub events topic prefix | +| events-topic-prefix | | Topic prefix of Hub events | | enable-device-auto-provisioning | | Enable device auto provisioning | | twins-graphite-config.push-uri | | | | region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | @@ -570,9 +570,9 @@ scw iot network list [arg=value ...] | Name | | Description | |------|---|-------------| | order-by | One of: `name_asc`, `name_desc`, `type_asc`, `type_desc`, `created_at_asc`, `created_at_desc` | Ordering of requested routes | -| name | | Filter on Network name | -| hub-id | | Filter on the hub | -| topic-prefix | | Filter on the topic prefix | +| name | | Network name to filter for | +| hub-id | | Hub ID to filter for | +| topic-prefix | | Topic prefix to filter for | | region | Default: `fr-par`
One of: `fr-par`, `all` | Region to target. If none is passed will use default region from the config | @@ -584,16 +584,16 @@ IoT Route commands. ### Create a route -Multiple route kinds can be created: -- Database Route. +Multiple kinds of routes can be created, such as: +- Database Route Create a route that will record subscribed MQTT messages into your database. You need to manage the database by yourself. - REST Route. Create a route that will call a REST API on received subscribed MQTT messages. - S3 Routes. Create a route that will put subscribed MQTT messages into an S3 bucket. - You need to create the bucket yourself and grant us write access. - The grant can be done with s3cmd (`s3cmd setacl s3:// --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031`). + You need to create the bucket yourself and grant write access. + Granting can be done with s3cmd (`s3cmd setacl s3:// --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031`). **Usage:** @@ -607,7 +607,7 @@ scw iot route create [arg=value ...] | Name | | Description | |------|---|-------------| | name | Default: `` | Route name | -| hub-id | | ID of the route's hub | +| hub-id | | Hub ID of the route | | topic | | Topic the route subscribes to. It must be a valid MQTT topic and up to 65535 characters | | s3-config.bucket-region | | | | s3-config.bucket-name | | | @@ -629,7 +629,7 @@ scw iot route create [arg=value ...] ### Delete a route -Delete a route. +Delete an existing route, specified by its route ID. Deleting a route is permanent, and cannot be undone. **Usage:** @@ -649,7 +649,7 @@ scw iot route delete [arg=value ...] ### Get a route -Get a route. +Get information for a particular route, specified by the route ID. The response returns full details of the route, including its type, the topic it subscribes to and its configuration. **Usage:** @@ -669,7 +669,7 @@ scw iot route get [arg=value ...] ### List routes -List routes. +List all routes in the specified region. By default, returned routes are ordered by creation date in ascending order, though this can be modified via the `order_by` field. **Usage:** @@ -683,15 +683,15 @@ scw iot route list [arg=value ...] | Name | | Description | |------|---|-------------| | order-by | One of: `name_asc`, `name_desc`, `hub_id_asc`, `hub_id_desc`, `type_asc`, `type_desc`, `created_at_asc`, `created_at_desc` | Ordering of requested routes | -| hub-id | | Filter on the hub | -| name | | Filter on route's name | +| hub-id | | Hub ID to filter for | +| name | | Route name to filter for | | region | Default: `fr-par`
One of: `fr-par`, `all` | Region to target. If none is passed will use default region from the config | ### Update a route -Update a route. +Update the parameters of an existing route, specified by its route ID. **Usage:** diff --git a/internal/namespaces/iot/v1/iot_cli.go b/internal/namespaces/iot/v1/iot_cli.go index 418236539b..b4a6828546 100644 --- a/internal/namespaces/iot/v1/iot_cli.go +++ b/internal/namespaces/iot/v1/iot_cli.go @@ -102,7 +102,7 @@ func iotNetwork() *core.Command { func iotHubList() *core.Command { return &core.Command{ Short: `List hubs`, - Long: `List hubs.`, + Long: `List all Hubs in the specified zone. By default, returned Hubs are ordered by creation date in ascending order, though this can be modified via the ` + "`" + `order_by` + "`" + ` field.`, Namespace: "iot", Resource: "hub", Verb: "list", @@ -111,7 +111,7 @@ func iotHubList() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "order-by", - Short: `Ordering of requested hub`, + Short: `Sort order of Hubs in the response`, Required: false, Deprecated: false, Positional: false, @@ -119,21 +119,21 @@ func iotHubList() *core.Command { }, { Name: "project-id", - Short: `Filter on project`, + Short: `Only list Hubs of this Project ID`, Required: false, Deprecated: false, Positional: false, }, { Name: "name", - Short: `Filter on the name`, + Short: `Hub name`, Required: false, Deprecated: false, Positional: false, }, { Name: "organization-id", - Short: `Filter on the organization`, + Short: `Only list Hubs of this Organization ID`, Required: false, Deprecated: false, Positional: false, @@ -210,7 +210,7 @@ func iotHubList() *core.Command { func iotHubCreate() *core.Command { return &core.Command{ Short: `Create a hub`, - Long: `Create a hub.`, + Long: `Create a new Hub in the targeted region, specifying its configuration including name and product plan.`, Namespace: "iot", Resource: "hub", Verb: "create", @@ -228,7 +228,7 @@ func iotHubCreate() *core.Command { core.ProjectIDArgSpec(), { Name: "product-plan", - Short: `Hub feature set`, + Short: `Hub product plan`, Required: true, Deprecated: false, Positional: false, @@ -244,7 +244,7 @@ func iotHubCreate() *core.Command { }, { Name: "events-topic-prefix", - Short: `Hub events topic prefix (default '$SCW/events')`, + Short: `Topic prefix (default '$SCW/events') of Hub events`, Required: false, Deprecated: false, Positional: false, @@ -271,7 +271,7 @@ func iotHubCreate() *core.Command { func iotHubGet() *core.Command { return &core.Command{ Short: `Get a hub`, - Long: `Get a hub.`, + Long: `Retrieve information about an existing IoT Hub, specified by its Hub ID. Its full details, including name, status and endpoint, are returned in the response object.`, Namespace: "iot", Resource: "hub", Verb: "get", @@ -301,7 +301,7 @@ func iotHubGet() *core.Command { func iotHubUpdate() *core.Command { return &core.Command{ Short: `Update a hub`, - Long: `Update a hub.`, + Long: `Update the parameters of an existing IoT Hub, specified by its Hub ID.`, Namespace: "iot", Resource: "hub", Verb: "update", @@ -310,7 +310,7 @@ func iotHubUpdate() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "hub-id", - Short: `Hub ID`, + Short: `ID of the Hub you want to update`, Required: true, Deprecated: false, Positional: true, @@ -324,7 +324,7 @@ func iotHubUpdate() *core.Command { }, { Name: "product-plan", - Short: `Hub feature set`, + Short: `Hub product plan`, Required: false, Deprecated: false, Positional: false, @@ -339,7 +339,7 @@ func iotHubUpdate() *core.Command { }, { Name: "events-topic-prefix", - Short: `Hub events topic prefix`, + Short: `Topic prefix of Hub events`, Required: false, Deprecated: false, Positional: false, @@ -373,7 +373,7 @@ func iotHubUpdate() *core.Command { func iotHubEnable() *core.Command { return &core.Command{ Short: `Enable a hub`, - Long: `Enable a hub.`, + Long: `Enable an existing IoT Hub, specified by its Hub ID.`, Namespace: "iot", Resource: "hub", Verb: "enable", @@ -403,7 +403,7 @@ func iotHubEnable() *core.Command { func iotHubDisable() *core.Command { return &core.Command{ Short: `Disable a hub`, - Long: `Disable a hub.`, + Long: `Disable an existing IoT Hub, specified by its Hub ID.`, Namespace: "iot", Resource: "hub", Verb: "disable", @@ -433,7 +433,7 @@ func iotHubDisable() *core.Command { func iotHubDelete() *core.Command { return &core.Command{ Short: `Delete a hub`, - Long: `Delete a hub.`, + Long: `Delete an existing IoT Hub, specified by its Hub ID. Deleting a Hub is permanent, and cannot be undone.`, Namespace: "iot", Resource: "hub", Verb: "delete", @@ -449,7 +449,7 @@ func iotHubDelete() *core.Command { }, { Name: "delete-devices", - Short: `Force deletion of devices added to this hub instead of rejecting operation`, + Short: `Defines whether to force the deletion of devices added to this Hub or reject the operation`, Required: false, Deprecated: false, Positional: false, @@ -476,7 +476,7 @@ func iotHubDelete() *core.Command { func iotHubSetCa() *core.Command { return &core.Command{ Short: `Set the certificate authority of a hub`, - Long: `Set the certificate authority of a hub.`, + Long: `Set a particular PEM-encoded certificate, specified by the Hub ID.`, Namespace: "iot", Resource: "hub", Verb: "set-ca", @@ -492,14 +492,14 @@ func iotHubSetCa() *core.Command { }, { Name: "ca-cert-pem", - Short: `The CA's PEM-encoded certificate`, + Short: `CA's PEM-encoded certificate`, Required: true, Deprecated: false, Positional: false, }, { Name: "challenge-cert-pem", - Short: `Proof of possession PEM-encoded certificate`, + Short: `Proof of possession of PEM-encoded certificate`, Required: true, Deprecated: false, Positional: false, @@ -520,7 +520,7 @@ func iotHubSetCa() *core.Command { func iotHubGetCa() *core.Command { return &core.Command{ Short: `Get the certificate authority of a hub`, - Long: `Get the certificate authority of a hub.`, + Long: `Get information for a particular PEM-encoded certificate, specified by the Hub ID.`, Namespace: "iot", Resource: "hub", Verb: "get-ca", @@ -549,7 +549,7 @@ func iotHubGetCa() *core.Command { func iotDeviceList() *core.Command { return &core.Command{ Short: `List devices`, - Long: `List devices.`, + Long: `List all devices in the specified region. By default, returned devices are ordered by creation date in ascending order, though this can be modified via the ` + "`" + `order_by` + "`" + ` field.`, Namespace: "iot", Resource: "device", Verb: "list", @@ -566,21 +566,21 @@ func iotDeviceList() *core.Command { }, { Name: "name", - Short: `Filter on the name`, + Short: `Name to filter for, only devices with this name will be returned`, Required: false, Deprecated: false, Positional: false, }, { Name: "hub-id", - Short: `Filter on the hub`, + Short: `Hub ID to filter for, only devices attached to this Hub will be returned`, Required: false, Deprecated: false, Positional: false, }, { Name: "allow-insecure", - Short: `Filter on the allow_insecure flag`, + Short: `Defines wheter to filter the allow_insecure flag`, Required: false, Deprecated: false, Positional: false, @@ -656,7 +656,7 @@ func iotDeviceList() *core.Command { func iotDeviceCreate() *core.Command { return &core.Command{ Short: `Add a device`, - Long: `Add a device.`, + Long: `Attach a device to a given Hub.`, Namespace: "iot", Resource: "device", Verb: "create", @@ -673,21 +673,21 @@ func iotDeviceCreate() *core.Command { }, { Name: "hub-id", - Short: `ID of the device's hub`, + Short: `Hub ID of the device`, Required: true, Deprecated: false, Positional: false, }, { Name: "allow-insecure", - Short: `Allow plain and server-authenticated SSL connections in addition to mutually-authenticated ones`, + Short: `Defines whether to allow plain and server-authenticated SSL connections in addition to mutually-authenticated ones`, Required: false, Deprecated: false, Positional: false, }, { Name: "allow-multiple-connections", - Short: `Allow multiple physical devices to connect with this device's credentials`, + Short: `Defines whether to allow multiple physical devices to connect with this device's credentials`, Required: false, Deprecated: false, Positional: false, @@ -745,7 +745,7 @@ func iotDeviceCreate() *core.Command { func iotDeviceGet() *core.Command { return &core.Command{ Short: `Get a device`, - Long: `Get a device.`, + Long: `Retrieve information about an existing device, specified by its device ID. Its full details, including name, status and ID, are returned in the response object.`, Namespace: "iot", Resource: "device", Verb: "get", @@ -775,7 +775,7 @@ func iotDeviceGet() *core.Command { func iotDeviceUpdate() *core.Command { return &core.Command{ Short: `Update a device`, - Long: `Update a device.`, + Long: `Update the parameters of an existing device, specified by its device ID.`, Namespace: "iot", Resource: "device", Verb: "update", @@ -791,21 +791,21 @@ func iotDeviceUpdate() *core.Command { }, { Name: "description", - Short: `Device description`, + Short: `Description for the device`, Required: false, Deprecated: false, Positional: false, }, { Name: "allow-insecure", - Short: `Allow plain and server-authenticated SSL connections in addition to mutually-authenticated ones`, + Short: `Defines whether to allow plain and server-authenticated SSL connections in addition to mutually-authenticated ones`, Required: false, Deprecated: false, Positional: false, }, { Name: "allow-multiple-connections", - Short: `Allow multiple physical devices to connect with this device's credentials`, + Short: `Defines whether to allow multiple physical devices to connect with this device's credentials`, Required: false, Deprecated: false, Positional: false, @@ -863,7 +863,7 @@ func iotDeviceUpdate() *core.Command { func iotDeviceEnable() *core.Command { return &core.Command{ Short: `Enable a device`, - Long: `Enable a device.`, + Long: `Enable a specific device, specified by its device ID.`, Namespace: "iot", Resource: "device", Verb: "enable", @@ -893,7 +893,7 @@ func iotDeviceEnable() *core.Command { func iotDeviceDisable() *core.Command { return &core.Command{ Short: `Disable a device`, - Long: `Disable a device.`, + Long: `Disable an existing device, specified by its device ID.`, Namespace: "iot", Resource: "device", Verb: "disable", @@ -923,7 +923,7 @@ func iotDeviceDisable() *core.Command { func iotDeviceRenewCertificate() *core.Command { return &core.Command{ Short: `Renew a device certificate`, - Long: `Renew a device certificate.`, + Long: `Renew the certificate of an existing device, specified by its device ID.`, Namespace: "iot", Resource: "device", Verb: "renew-certificate", @@ -953,7 +953,7 @@ func iotDeviceRenewCertificate() *core.Command { func iotDeviceSetCertificate() *core.Command { return &core.Command{ Short: `Set a custom certificate on a device`, - Long: `Set a custom certificate on a device.`, + Long: `Switch the existing certificate of a given device with an EM-encoded custom certificate.`, Namespace: "iot", Resource: "device", Verb: "set-certificate", @@ -969,7 +969,7 @@ func iotDeviceSetCertificate() *core.Command { }, { Name: "certificate-pem", - Short: `The PEM-encoded custom certificate`, + Short: `PEM-encoded custom certificate`, Required: true, Deprecated: false, Positional: false, @@ -990,7 +990,7 @@ func iotDeviceSetCertificate() *core.Command { func iotDeviceGetCertificate() *core.Command { return &core.Command{ Short: `Get a device's certificate`, - Long: `Get a device's certificate.`, + Long: `Get information for a particular PEM-encoded certificate, specified by the device ID. The response returns full details of the device, including its type of certificate.`, Namespace: "iot", Resource: "device", Verb: "get-certificate", @@ -1020,7 +1020,7 @@ func iotDeviceGetCertificate() *core.Command { func iotDeviceDelete() *core.Command { return &core.Command{ Short: `Remove a device`, - Long: `Remove a device.`, + Long: `Remove a specific device from the specific Hub it is attached to.`, Namespace: "iot", Resource: "device", Verb: "delete", @@ -1093,7 +1093,7 @@ func iotDeviceGetMetrics() *core.Command { func iotRouteList() *core.Command { return &core.Command{ Short: `List routes`, - Long: `List routes.`, + Long: `List all routes in the specified region. By default, returned routes are ordered by creation date in ascending order, though this can be modified via the ` + "`" + `order_by` + "`" + ` field.`, Namespace: "iot", Resource: "route", Verb: "list", @@ -1110,14 +1110,14 @@ func iotRouteList() *core.Command { }, { Name: "hub-id", - Short: `Filter on the hub`, + Short: `Hub ID to filter for`, Required: false, Deprecated: false, Positional: false, }, { Name: "name", - Short: `Filter on route's name`, + Short: `Route name to filter for`, Required: false, Deprecated: false, Positional: false, @@ -1167,16 +1167,16 @@ func iotRouteList() *core.Command { func iotRouteCreate() *core.Command { return &core.Command{ Short: `Create a route`, - Long: `Multiple route kinds can be created: -- Database Route. + Long: `Multiple kinds of routes can be created, such as: +- Database Route Create a route that will record subscribed MQTT messages into your database. You need to manage the database by yourself. - REST Route. Create a route that will call a REST API on received subscribed MQTT messages. - S3 Routes. Create a route that will put subscribed MQTT messages into an S3 bucket. - You need to create the bucket yourself and grant us write access. - The grant can be done with s3cmd (` + "`" + `s3cmd setacl s3:// --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031` + "`" + `).`, + You need to create the bucket yourself and grant write access. + Granting can be done with s3cmd (` + "`" + `s3cmd setacl s3:// --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031` + "`" + `).`, Namespace: "iot", Resource: "route", Verb: "create", @@ -1193,7 +1193,7 @@ func iotRouteCreate() *core.Command { }, { Name: "hub-id", - Short: `ID of the route's hub`, + Short: `Hub ID of the route`, Required: false, Deprecated: false, Positional: false, @@ -1308,7 +1308,7 @@ func iotRouteCreate() *core.Command { func iotRouteUpdate() *core.Command { return &core.Command{ Short: `Update a route`, - Long: `Update a route.`, + Long: `Update the parameters of an existing route, specified by its route ID.`, Namespace: "iot", Resource: "route", Verb: "update", @@ -1439,7 +1439,7 @@ func iotRouteUpdate() *core.Command { func iotRouteGet() *core.Command { return &core.Command{ Short: `Get a route`, - Long: `Get a route.`, + Long: `Get information for a particular route, specified by the route ID. The response returns full details of the route, including its type, the topic it subscribes to and its configuration.`, Namespace: "iot", Resource: "route", Verb: "get", @@ -1469,7 +1469,7 @@ func iotRouteGet() *core.Command { func iotRouteDelete() *core.Command { return &core.Command{ Short: `Delete a route`, - Long: `Delete a route.`, + Long: `Delete an existing route, specified by its route ID. Deleting a route is permanent, and cannot be undone.`, Namespace: "iot", Resource: "route", Verb: "delete", @@ -1522,21 +1522,21 @@ func iotNetworkList() *core.Command { }, { Name: "name", - Short: `Filter on Network name`, + Short: `Network name to filter for`, Required: false, Deprecated: false, Positional: false, }, { Name: "hub-id", - Short: `Filter on the hub`, + Short: `Hub ID to filter for`, Required: false, Deprecated: false, Positional: false, }, { Name: "topic-prefix", - Short: `Filter on the topic prefix`, + Short: `Topic prefix to filter for`, Required: false, Deprecated: false, Positional: false,