Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(iot): add more documentation #2406

Merged
merged 3 commits into from
Jul 7, 2022
Merged

docs(iot): add more documentation #2406

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
13fa128
feat: update generated cli
scaleway-bot Jul 7, 2022
2331f3f
Merge branch 'master' into v1.2539.0
remyleone Jul 7, 2022
c282a23
Fix
remyleone Jul 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions cmd/scw/testdata/test-all-usage-iot-device-create-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ ARGS:
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
[message-filters.publish.policy] (unknown | accept | reject)
[message-filters.publish.topics.{index}]
[message-filters.subscribe.policy] (unknown | accept | reject)
[message-filters.subscribe.topics.{index}]
[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)
[message-filters.subscribe.topics.{index}] List of topics to accept or reject. It must be valid MQTT topics and up to 65535 characters
[description] Device description
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)

Expand Down
8 changes: 4 additions & 4 deletions cmd/scw/testdata/test-all-usage-iot-device-update-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ ARGS:
[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
[message-filters.publish.policy] (unknown | accept | reject)
[message-filters.publish.topics.{index}]
[message-filters.subscribe.policy] (unknown | accept | reject)
[message-filters.subscribe.topics.{index}]
[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)
[message-filters.subscribe.topics.{index}] List of topics to accept or reject. It must be valid MQTT topics and up to 65535 characters
[hub-id] Change Hub for this device, additional fees may apply, see IoT Hub pricing
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)

Expand Down
16 changes: 8 additions & 8 deletions docs/commands/iot.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,10 @@ scw iot device create [arg=value ...]
| 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 |
| message-filters.publish.policy | One of: `unknown`, `accept`, `reject` | |
| message-filters.publish.topics.{index} | | |
| message-filters.subscribe.policy | One of: `unknown`, `accept`, `reject` | |
| message-filters.subscribe.topics.{index} | | |
| 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 |
| message-filters.subscribe.topics.{index} | | List of topics to accept or reject. It must be valid MQTT topics and up to 65535 characters |
| description | | Device description |
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |

Expand Down Expand Up @@ -275,10 +275,10 @@ scw iot device update <device-id ...> [arg=value ...]
| 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 |
| message-filters.publish.policy | One of: `unknown`, `accept`, `reject` | |
| message-filters.publish.topics.{index} | | |
| message-filters.subscribe.policy | One of: `unknown`, `accept`, `reject` | |
| message-filters.subscribe.topics.{index} | | |
| 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 |
| message-filters.subscribe.topics.{index} | | List of topics to accept or reject. It must be valid MQTT topics and up to 65535 characters |
| hub-id | | Change Hub for this device, additional fees may apply, see IoT Hub pricing |
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |

Expand Down
8 changes: 8 additions & 0 deletions internal/namespaces/iot/v1/iot_cli.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -684,26 +684,30 @@ func iotDeviceCreate() *core.Command {
},
{
Name: "message-filters.publish.policy",
Short: `How to use the topic list`,
Required: false,
Deprecated: false,
Positional: false,
EnumValues: []string{"unknown", "accept", "reject"},
},
{
Name: "message-filters.publish.topics.{index}",
Short: `List of topics to accept or reject. It must be valid MQTT topics and up to 65535 characters`,
Required: false,
Deprecated: false,
Positional: false,
},
{
Name: "message-filters.subscribe.policy",
Short: `How to use the topic list`,
Required: false,
Deprecated: false,
Positional: false,
EnumValues: []string{"unknown", "accept", "reject"},
},
{
Name: "message-filters.subscribe.topics.{index}",
Short: `List of topics to accept or reject. It must be valid MQTT topics and up to 65535 characters`,
Required: false,
Deprecated: false,
Positional: false,
Expand Down Expand Up @@ -798,26 +802,30 @@ func iotDeviceUpdate() *core.Command {
},
{
Name: "message-filters.publish.policy",
Short: `How to use the topic list`,
Required: false,
Deprecated: false,
Positional: false,
EnumValues: []string{"unknown", "accept", "reject"},
},
{
Name: "message-filters.publish.topics.{index}",
Short: `List of topics to accept or reject. It must be valid MQTT topics and up to 65535 characters`,
Required: false,
Deprecated: false,
Positional: false,
},
{
Name: "message-filters.subscribe.policy",
Short: `How to use the topic list`,
Required: false,
Deprecated: false,
Positional: false,
EnumValues: []string{"unknown", "accept", "reject"},
},
{
Name: "message-filters.subscribe.topics.{index}",
Short: `List of topics to accept or reject. It must be valid MQTT topics and up to 65535 characters`,
Required: false,
Deprecated: false,
Positional: false,
Expand Down