Skip to content

Commit c99efc8

Browse files
authored
chore: remove nat from documentation (#4475)
1 parent 480401b commit c99efc8

File tree

5 files changed

+11
-11
lines changed

5 files changed

+11
-11
lines changed

cmd/scw/testdata/test-all-usage-instance-ip-create-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ ARGS:
1919
[project-id] Project ID to use. If none is passed the default project ID will be used
2020
[tags.{index}] Tags of the IP
2121
[server] UUID of the Instance you want to attach the IP to
22-
[type] IP type to reserve (either 'routed_ipv4' or 'routed_ipv6', use of 'nat' is deprecated) (unknown_iptype | nat | routed_ipv4 | routed_ipv6)
22+
[type] IP type to reserve (either 'routed_ipv4' or 'routed_ipv6') (unknown_iptype | routed_ipv4 | routed_ipv6)
2323
[organization-id] Organization ID to use. If none is passed the default organization ID will be used
2424
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3)
2525

cmd/scw/testdata/test-all-usage-instance-ip-list-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ ARGS:
1616
[project-id] Project ID in which the IPs are reserved
1717
[tags] Filter IPs with these exact tags (to filter with several tags, use commas to separate them)
1818
[name] Filter on the IP address (Works as a LIKE operation on the IP address)
19-
[type] Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4', 'routed_ipv6' or 'nat')
19+
[type] Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6')
2020
[organization-id] Organization ID in which the IPs are reserved
2121
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3 | all)
2222

cmd/scw/testdata/test-all-usage-instance-ip-update-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ EXAMPLES:
1818
ARGS:
1919
ip IP ID or IP address
2020
[reverse] Reverse domain name
21-
[type] Convert a 'nat' IP to a 'routed_ipv4' (unknown_iptype | nat | routed_ipv4 | routed_ipv6)
21+
[type] Should have no effect (unknown_iptype | routed_ipv4 | routed_ipv6)
2222
[tags.{index}] An array of keywords you want to tag this IP with
2323
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3)
2424

docs/commands/instance.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -377,7 +377,7 @@ scw instance ip create [arg=value ...]
377377
| project-id | | Project ID to use. If none is passed the default project ID will be used |
378378
| tags.{index} | | Tags of the IP |
379379
| server | | UUID of the Instance you want to attach the IP to |
380-
| type | One of: `unknown_iptype`, `nat`, `routed_ipv4`, `routed_ipv6` | IP type to reserve (either 'routed_ipv4' or 'routed_ipv6', use of 'nat' is deprecated) |
380+
| type | One of: `unknown_iptype`, `routed_ipv4`, `routed_ipv6` | IP type to reserve (either 'routed_ipv4' or 'routed_ipv6') |
381381
| organization-id | | Organization ID to use. If none is passed the default organization ID will be used |
382382
| zone | Default: `fr-par-1`<br />One of: `fr-par-1`, `fr-par-2`, `fr-par-3`, `nl-ams-1`, `nl-ams-2`, `nl-ams-3`, `pl-waw-1`, `pl-waw-2`, `pl-waw-3` | Zone to target. If none is passed will use default zone from the config |
383383

@@ -536,7 +536,7 @@ scw instance ip list [arg=value ...]
536536
| project-id | | Project ID in which the IPs are reserved |
537537
| tags | | Filter IPs with these exact tags (to filter with several tags, use commas to separate them) |
538538
| name | | Filter on the IP address (Works as a LIKE operation on the IP address) |
539-
| type | | Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4', 'routed_ipv6' or 'nat') |
539+
| type | | Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6') |
540540
| organization-id | | Organization ID in which the IPs are reserved |
541541
| zone | Default: `fr-par-1`<br />One of: `fr-par-1`, `fr-par-2`, `fr-par-3`, `nl-ams-1`, `nl-ams-2`, `nl-ams-3`, `pl-waw-1`, `pl-waw-2`, `pl-waw-3`, `all` | Zone to target. If none is passed will use default zone from the config |
542542

@@ -574,7 +574,7 @@ scw instance ip update <ip ...> [arg=value ...]
574574
|------|---|-------------|
575575
| ip | Required | IP ID or IP address |
576576
| reverse | | Reverse domain name |
577-
| type | One of: `unknown_iptype`, `nat`, `routed_ipv4`, `routed_ipv6` | Convert a 'nat' IP to a 'routed_ipv4' |
577+
| type | One of: `unknown_iptype`, `routed_ipv4`, `routed_ipv6` | Should have no effect |
578578
| tags.{index} | | An array of keywords you want to tag this IP with |
579579
| zone | Default: `fr-par-1`<br />One of: `fr-par-1`, `fr-par-2`, `fr-par-3`, `nl-ams-1`, `nl-ams-2`, `nl-ams-3`, `pl-waw-1`, `pl-waw-2`, `pl-waw-3` | Zone to target. If none is passed will use default zone from the config |
580580

internal/namespaces/instance/v1/instance_cli.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3315,7 +3315,7 @@ func instanceIPList() *core.Command {
33153315
},
33163316
{
33173317
Name: "type",
3318-
Short: `Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4', 'routed_ipv6' or 'nat')`,
3318+
Short: `Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6')`,
33193319
Required: false,
33203320
Deprecated: false,
33213321
Positional: false,
@@ -3421,11 +3421,11 @@ func instanceIPCreate() *core.Command {
34213421
},
34223422
{
34233423
Name: "type",
3424-
Short: `IP type to reserve (either 'routed_ipv4' or 'routed_ipv6', use of 'nat' is deprecated)`,
3424+
Short: `IP type to reserve (either 'routed_ipv4' or 'routed_ipv6')`,
34253425
Required: false,
34263426
Deprecated: false,
34273427
Positional: false,
3428-
EnumValues: []string{"unknown_iptype", "nat", "routed_ipv4", "routed_ipv6"},
3428+
EnumValues: []string{"unknown_iptype", "routed_ipv4", "routed_ipv6"},
34293429
},
34303430
core.OrganizationArgSpec(),
34313431
core.ZoneArgSpec(scw.ZoneFrPar1, scw.ZoneFrPar2, scw.ZoneFrPar3, scw.ZoneNlAms1, scw.ZoneNlAms2, scw.ZoneNlAms3, scw.ZonePlWaw1, scw.ZonePlWaw2, scw.ZonePlWaw3),
@@ -3525,11 +3525,11 @@ func instanceIPUpdate() *core.Command {
35253525
},
35263526
{
35273527
Name: "type",
3528-
Short: `Convert a 'nat' IP to a 'routed_ipv4'`,
3528+
Short: `Should have no effect`,
35293529
Required: false,
35303530
Deprecated: false,
35313531
Positional: false,
3532-
EnumValues: []string{"unknown_iptype", "nat", "routed_ipv4", "routed_ipv6"},
3532+
EnumValues: []string{"unknown_iptype", "routed_ipv4", "routed_ipv6"},
35333533
},
35343534
{
35353535
Name: "tags.{index}",

0 commit comments

Comments
 (0)