Skip to content

Commit 4a41108

Browse files
committed
feat(rdb): acl: doc for all
1 parent 0e00479 commit 4a41108

File tree

5 files changed

+27
-30
lines changed

5 files changed

+27
-30
lines changed

cmd/scw/testdata/test-all-usage-rdb-acl-add-usage.golden

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,12 @@
33
Add an additional ACL rule to a Database Instance.
44

55
USAGE:
6-
scw rdb acl add [arg=value ...]
6+
scw rdb acl add <acl-rule-ips ...> [arg=value ...]
77

88
ARGS:
9-
instance-id UUID of the Database Instance you want to add ACL rules to
10-
[rules.{index}.ip]
11-
[rules.{index}.description]
12-
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
9+
acl-rule-ips IP addresses defined in the ACL rules of the Database Instance
10+
instance-id ID of the Database Instance
11+
[region=fr-par] Region to target. If none is passed will use default region from the config
1312

1413
FLAGS:
1514
-h, --help help for add

cmd/scw/testdata/test-all-usage-rdb-acl-delete-usage.golden

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
Delete one or more ACL rules of a Database Instance.
44

55
USAGE:
6-
scw rdb acl delete [arg=value ...]
6+
scw rdb acl delete <acl-rule-ips ...> [arg=value ...]
77

88
ARGS:
9-
instance-id UUID of the Database Instance you want to delete an ACL rule from
10-
rules.{index}.ip IP addresses defined in the ACL rules of the Database Instance
11-
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
9+
acl-rule-ips IP addresses defined in the ACL rules of the Database Instance
10+
instance-id ID of the Database Instance
11+
[region=fr-par] Region to target. If none is passed will use default region from the config
1212

1313
FLAGS:
1414
-h, --help help for delete

cmd/scw/testdata/test-all-usage-rdb-acl-edit-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ USAGE:
77
scw rdb acl edit <instance-id ...> [arg=value ...]
88

99
ARGS:
10-
instance-id ID of the database instance
10+
instance-id ID of the Database Instance
1111
[mode=yaml] marshaling used when editing data (yaml | json)
1212
[region=fr-par] Region to target. If none is passed will use default region from the config
1313

cmd/scw/testdata/test-all-usage-rdb-acl-set-usage.golden

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@
33
Replace all the ACL rules of a Database Instance.
44

55
USAGE:
6-
scw rdb acl set [arg=value ...]
6+
scw rdb acl set <acl-rule-ips ...> [arg=value ...]
77

88
ARGS:
9-
instance-id UUID of the Database Instance where the ACL rules must be set
10-
[rules.{index}.ip]
11-
[rules.{index}.description]
12-
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
9+
acl-rule-ips IP addresses defined in the ACL rules of the Database Instance
10+
instance-id ID of the Database Instance
11+
[region=fr-par] Region to target. If none is passed will use default region from the config
1312

1413
FLAGS:
1514
-h, --help help for set
15+
-w, --wait wait until the acl is ready
1616

1717
GLOBAL FLAGS:
1818
-c, --config string The path to the config file

docs/commands/rdb.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -91,18 +91,17 @@ Add an additional ACL rule to a Database Instance.
9191
**Usage:**
9292

9393
```
94-
scw rdb acl add [arg=value ...]
94+
scw rdb acl add <acl-rule-ips ...> [arg=value ...]
9595
```
9696

9797

9898
**Args:**
9999

100100
| Name | | Description |
101101
|------|---|-------------|
102-
| instance-id | Required | UUID of the Database Instance you want to add ACL rules to |
103-
| rules.{index}.ip | | |
104-
| rules.{index}.description | | |
105-
| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
102+
| acl-rule-ips | Required | IP addresses defined in the ACL rules of the Database Instance |
103+
| instance-id | Required | ID of the Database Instance |
104+
| region | Default: `fr-par` | Region to target. If none is passed will use default region from the config |
106105

107106

108107

@@ -113,17 +112,17 @@ Delete one or more ACL rules of a Database Instance.
113112
**Usage:**
114113

115114
```
116-
scw rdb acl delete [arg=value ...]
115+
scw rdb acl delete <acl-rule-ips ...> [arg=value ...]
117116
```
118117

119118

120119
**Args:**
121120

122121
| Name | | Description |
123122
|------|---|-------------|
124-
| instance-id | Required | UUID of the Database Instance you want to delete an ACL rule from |
125-
| rules.{index}.ip | Required | IP addresses defined in the ACL rules of the Database Instance |
126-
| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
123+
| acl-rule-ips | Required | IP addresses defined in the ACL rules of the Database Instance |
124+
| instance-id | Required | ID of the Database Instance |
125+
| region | Default: `fr-par` | Region to target. If none is passed will use default region from the config |
127126

128127

129128

@@ -143,7 +142,7 @@ scw rdb acl edit <instance-id ...> [arg=value ...]
143142

144143
| Name | | Description |
145144
|------|---|-------------|
146-
| instance-id | Required | ID of the database instance |
145+
| instance-id | Required | ID of the Database Instance |
147146
| mode | Default: `yaml`<br />One of: `yaml`, `json` | marshaling used when editing data |
148147
| region | Default: `fr-par` | Region to target. If none is passed will use default region from the config |
149148

@@ -176,18 +175,17 @@ Replace all the ACL rules of a Database Instance.
176175
**Usage:**
177176

178177
```
179-
scw rdb acl set [arg=value ...]
178+
scw rdb acl set <acl-rule-ips ...> [arg=value ...]
180179
```
181180

182181

183182
**Args:**
184183

185184
| Name | | Description |
186185
|------|---|-------------|
187-
| instance-id | Required | UUID of the Database Instance where the ACL rules must be set |
188-
| rules.{index}.ip | | |
189-
| rules.{index}.description | | |
190-
| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
186+
| acl-rule-ips | Required | IP addresses defined in the ACL rules of the Database Instance |
187+
| instance-id | Required | ID of the Database Instance |
188+
| region | Default: `fr-par` | Region to target. If none is passed will use default region from the config |
191189

192190

193191

0 commit comments

Comments
 (0)