Skip to content

Commit 03b39e7

Browse files
committed
Fix
1 parent 1aa1097 commit 03b39e7

9 files changed

+30
-30
lines changed

cmd/scw/testdata/test-all-usage-iot-device-get-metrics-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Get a device's metrics.
3+
Get the metrics of an existing device, specified by its device ID.
44

55
USAGE:
66
scw iot device get-metrics <device-id ...> [arg=value ...]

cmd/scw/testdata/test-all-usage-iot-network-create-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Create a new Network.
3+
Create a new network for an existing hub. Beside the default network, you can add networks for different data providers. Possible network types are Sigfox and REST.
44

55
USAGE:
66
scw iot network create [arg=value ...]

cmd/scw/testdata/test-all-usage-iot-network-delete-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Delete a Network.
3+
Delete an existing network, specified by its network ID. Deleting a network is permanent, and cannot be undone.
44

55
USAGE:
66
scw iot network delete <network-id ...> [arg=value ...]

cmd/scw/testdata/test-all-usage-iot-network-get-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Retrieve a specific Network.
3+
Retrieve an existing network, specified by its network ID. The response returns full details of the network, including its type, the topic prefix and its endpoint.
44

55
USAGE:
66
scw iot network get <network-id ...> [arg=value ...]

cmd/scw/testdata/test-all-usage-iot-network-list-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
List the Networks.
3+
List the networks.
44

55
USAGE:
66
scw iot network list [arg=value ...]

cmd/scw/testdata/test-all-usage-iot-network-usage.golden

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ USAGE:
66
scw iot network <command>
77

88
AVAILABLE COMMANDS:
9-
create Create a new Network
9+
create Create a new network
1010
delete Delete a Network
11-
get Retrieve a specific Network
12-
list List the Networks
11+
get Retrieve a specific network
12+
list List the networks
1313

1414
FLAGS:
1515
-h, --help help for network

cmd/scw/testdata/test-all-usage-iot-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
IoT API.
3+
IoT Hub API.
44

55
USAGE:
66
scw iot <command>

docs/commands/iot.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- DO NOT EDIT: this file is automatically generated using scw-doc-gen -->
22
# Documentation for `scw iot`
3-
IoT API.
3+
IoT Hub API.
44

55
- [IoT Device commands](#iot-device-commands)
66
- [Add a device](#add-a-device)
@@ -25,10 +25,10 @@ IoT API.
2525
- [Set the certificate authority of a hub](#set-the-certificate-authority-of-a-hub)
2626
- [Update a hub](#update-a-hub)
2727
- [IoT Network commands](#iot-network-commands)
28-
- [Create a new Network](#create-a-new-network)
28+
- [Create a new network](#create-a-new-network)
2929
- [Delete a Network](#delete-a-network)
30-
- [Retrieve a specific Network](#retrieve-a-specific-network)
31-
- [List the Networks](#list-the-networks)
30+
- [Retrieve a specific network](#retrieve-a-specific-network)
31+
- [List the networks](#list-the-networks)
3232
- [IoT Route commands](#iot-route-commands)
3333
- [Create a route](#create-a-route)
3434
- [Delete a route](#delete-a-route)
@@ -172,7 +172,7 @@ scw iot device get-certificate <device-id ...> [arg=value ...]
172172

173173
### Get a device's metrics
174174

175-
Get a device's metrics.
175+
Get the metrics of an existing device, specified by its device ID.
176176

177177
**Usage:**
178178

@@ -491,9 +491,9 @@ scw iot hub update <hub-id ...> [arg=value ...]
491491
IoT Network commands.
492492

493493

494-
### Create a new Network
494+
### Create a new network
495495

496-
Create a new Network.
496+
Create a new network for an existing hub. Beside the default network, you can add networks for different data providers. Possible network types are Sigfox and REST.
497497

498498
**Usage:**
499499

@@ -516,7 +516,7 @@ scw iot network create [arg=value ...]
516516

517517
### Delete a Network
518518

519-
Delete a Network.
519+
Delete an existing network, specified by its network ID. Deleting a network is permanent, and cannot be undone.
520520

521521
**Usage:**
522522

@@ -534,9 +534,9 @@ scw iot network delete <network-id ...> [arg=value ...]
534534

535535

536536

537-
### Retrieve a specific Network
537+
### Retrieve a specific network
538538

539-
Retrieve a specific Network.
539+
Retrieve an existing network, specified by its network ID. The response returns full details of the network, including its type, the topic prefix and its endpoint.
540540

541541
**Usage:**
542542

@@ -554,9 +554,9 @@ scw iot network get <network-id ...> [arg=value ...]
554554

555555

556556

557-
### List the Networks
557+
### List the networks
558558

559-
List the Networks.
559+
List the networks.
560560

561561
**Usage:**
562562

internal/namespaces/iot/v1/iot_cli.go

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ func GetGeneratedCommands() *core.Commands {
5858
func iotRoot() *core.Command {
5959
return &core.Command{
6060
Short: `This API allows you to manage IoT hubs and devices`,
61-
Long: `IoT API.`,
61+
Long: `IoT Hub API.`,
6262
Namespace: "iot",
6363
}
6464
}
@@ -1056,7 +1056,7 @@ func iotDeviceDelete() *core.Command {
10561056
func iotDeviceGetMetrics() *core.Command {
10571057
return &core.Command{
10581058
Short: `Get a device's metrics`,
1059-
Long: `Get a device's metrics.`,
1059+
Long: `Get the metrics of an existing device, specified by its device ID.`,
10601060
Namespace: "iot",
10611061
Resource: "device",
10621062
Verb: "get-metrics",
@@ -1504,8 +1504,8 @@ func iotRouteDelete() *core.Command {
15041504

15051505
func iotNetworkList() *core.Command {
15061506
return &core.Command{
1507-
Short: `List the Networks`,
1508-
Long: `List the Networks.`,
1507+
Short: `List the networks`,
1508+
Long: `List the networks.`,
15091509
Namespace: "iot",
15101510
Resource: "network",
15111511
Verb: "list",
@@ -1588,8 +1588,8 @@ func iotNetworkList() *core.Command {
15881588

15891589
func iotNetworkCreate() *core.Command {
15901590
return &core.Command{
1591-
Short: `Create a new Network`,
1592-
Long: `Create a new Network.`,
1591+
Short: `Create a new network`,
1592+
Long: `Create a new network for an existing hub. Beside the default network, you can add networks for different data providers. Possible network types are Sigfox and REST.`,
15931593
Namespace: "iot",
15941594
Resource: "network",
15951595
Verb: "create",
@@ -1641,8 +1641,8 @@ func iotNetworkCreate() *core.Command {
16411641

16421642
func iotNetworkGet() *core.Command {
16431643
return &core.Command{
1644-
Short: `Retrieve a specific Network`,
1645-
Long: `Retrieve a specific Network.`,
1644+
Short: `Retrieve a specific network`,
1645+
Long: `Retrieve an existing network, specified by its network ID. The response returns full details of the network, including its type, the topic prefix and its endpoint.`,
16461646
Namespace: "iot",
16471647
Resource: "network",
16481648
Verb: "get",
@@ -1672,7 +1672,7 @@ func iotNetworkGet() *core.Command {
16721672
func iotNetworkDelete() *core.Command {
16731673
return &core.Command{
16741674
Short: `Delete a Network`,
1675-
Long: `Delete a Network.`,
1675+
Long: `Delete an existing network, specified by its network ID. Deleting a network is permanent, and cannot be undone.`,
16761676
Namespace: "iot",
16771677
Resource: "network",
16781678
Verb: "delete",

0 commit comments

Comments
 (0)