Skip to content

Commit 6406bad

Browse files
scaleway-botremyleone
scaleway-bot
and
remyleone
authored
docs(flexIP): revamp api documentation (#3034)
Co-authored-by: Rémy Léone <[email protected]>
1 parent f0013f6 commit 6406bad

15 files changed

+155
-155
lines changed

‎cmd/scw/testdata/test-all-usage-fip-ip-attach-usage.golden

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Attach a Flexible IP to a server.
3+
Attach an existing flexible IP to a specified Elastic Metal server.
44

55
USAGE:
66
scw fip ip attach [arg=value ...]
77

88
ARGS:
9-
fips-ids.{index} A list of Flexible IP IDs to attach
10-
server-id A server ID on which to attach the Flexible IPs
9+
fips-ids.{index} List of flexible IP IDs to attach to a server
10+
server-id ID of the server on which to attach the flexible IPs
1111
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1)
1212

1313
FLAGS:

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Create a Flexible IP.
3+
Generate a new flexible IP within a given zone, specifying its configuration including Project ID and description.
44

55
USAGE:
66
scw fip ip create [arg=value ...]
77

88
ARGS:
99
[project-id] Project ID to use. If none is passed the default project ID will be used
10-
[description] Description to associate with the Flexible IP, max 255 characters
11-
[tags.{index}] Tags to associate to the Flexible IP
12-
[server-id] Server ID on which to attach the created Flexible IP
13-
[reverse] Reverse DNS value
14-
[is-ipv6] If true, creates a Flexible IP with an ipv6 address
10+
[description] Flexible IP description (max. of 255 characters)
11+
[tags.{index}] Tags to associate to the flexible IP
12+
[server-id] ID of the server to which the newly created flexible IP will be attached.
13+
[reverse] Value of the reverse DNS
14+
[is-ipv6] Defines whether the flexible IP has an IPv6 address.
1515
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1)
1616

1717
FLAGS:

‎cmd/scw/testdata/test-all-usage-fip-ip-delete-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Delete a Flexible IP.
3+
Delete an existing flexible IP, specified by its ID and zone. Note that deleting a flexible IP is permanent and cannot be undone.
44

55
USAGE:
66
scw fip ip delete <fip-id ...> [arg=value ...]
77

88
ARGS:
9-
fip-id ID of the Flexible IP to delete
9+
fip-id ID of the flexible IP to delete
1010
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1)
1111

1212
FLAGS:

‎cmd/scw/testdata/test-all-usage-fip-ip-detach-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Detach a Flexible IP from a server.
3+
Detach an existing flexible IP from a specified Elastic Metal server.
44

55
USAGE:
66
scw fip ip detach [arg=value ...]
77

88
ARGS:
9-
fips-ids.{index} A list of Flexible IP IDs to detach
9+
fips-ids.{index} List of flexible IP IDs to detach from a server. Multiple IDs can be provided. Note that flexible IPs must belong to the same MAC group.
1010
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1)
1111

1212
FLAGS:

‎cmd/scw/testdata/test-all-usage-fip-ip-get-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Get a Flexible IP.
3+
Retrieve information about an existing flexible IP, specified by its ID and zone. Its full details, including Project ID, description and status, are returned in the response object.
44

55
USAGE:
66
scw fip ip get <fip-id ...> [arg=value ...]
77

88
ARGS:
9-
fip-id Flexible IP ID
9+
fip-id ID of the flexible IP
1010
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1)
1111

1212
FLAGS:

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
List Flexible IPs.
3+
List all flexible IPs within a given zone.
44

55
USAGE:
66
scw fip ip list [arg=value ...]
77

88
ARGS:
9-
[order-by] The sort order of the returned Flexible IPs (created_at_asc | created_at_desc)
10-
[tags.{index}] Filter Flexible IPs with one or more matching tags
11-
[status.{index}] Filter Flexible IPs by status (unknown | ready | updating | attached | error | detaching | locked)
12-
[server-ids.{index}] Filter Flexible IPs by server IDs
13-
[project-id] Filter Flexible IPs by project ID
14-
[organization-id] Filter Flexible IPs by organization ID
9+
[order-by] Sort order of the returned flexible IPs (created_at_asc | created_at_desc)
10+
[tags.{index}] Filter by tag, only flexible IPs with one or more matching tags will be returned
11+
[status.{index}] Filter by status, only flexible IPs with this status will be returned (unknown | ready | updating | attached | error | detaching | locked)
12+
[server-ids.{index}] Filter by server IDs, only flexible IPs with these server IDs will be returned
13+
[project-id] Filter by Project ID, only flexible IPs from this Project will be returned
14+
[organization-id] Filter by Organization ID, only flexible IPs from this Organization will be returned
1515
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | all)
1616

1717
FLAGS:

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Update a Flexible IP.
3+
Update the parameters of an existing flexible IP, specified by its ID and zone. These parameters include tags and description.
44

55
USAGE:
66
scw fip ip update <fip-id ...> [arg=value ...]
77

88
ARGS:
9-
fip-id ID of the Flexible IP to update
10-
[description] Description to associate with the Flexible IP, max 255 characters
11-
[tags.{index}] Tags to associate with the Flexible IP
12-
[reverse] Reverse DNS value
9+
fip-id ID of the flexible IP to update
10+
[description] Flexible IP description (max. 255 characters)
11+
[tags.{index}] Tags associated with the flexible IP
12+
[reverse] Value of the reverse DNS
1313
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1)
1414

1515
FLAGS:

‎cmd/scw/testdata/test-all-usage-fip-ip-usage.golden

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
A Flexible IP can be attached to any server in the same zone.
4-
A server can be linked with multiple Flexible IPs attached to it.
3+
A flexible IP can be attached to any Elastic Metal server within the same zone.
4+
Multiple flexible IPs can be attached to a server.
55

66
USAGE:
77
scw fip ip <command>
88

99
AVAILABLE COMMANDS:
10-
attach Attach a Flexible IP to a server
11-
create Create a Flexible IP
12-
delete Delete a Flexible IP
13-
detach Detach a Flexible IP from a server
14-
get Get a Flexible IP
15-
list List Flexible IPs
16-
update Update a Flexible IP
10+
attach Attach an existing flexible IP to a server
11+
create Create a new flexible IP
12+
delete Delete an existing flexible IP
13+
detach Detach an existing flexible IP from a server
14+
get Get an existing flexible IP
15+
list List flexible IPs
16+
update Update an existing flexible IP
1717

1818
FLAGS:
1919
-h, --help help for ip

‎cmd/scw/testdata/test-all-usage-fip-mac-create-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Generate a virtual MAC on a given Flexible IP.
3+
Generate a virtual MAC (Media Access Control) address on an existing flexible IP.
44

55
USAGE:
66
scw fip mac create [arg=value ...]
77

88
ARGS:
9-
fip-id Flexible IP ID on which to generate a Virtual MAC
9+
fip-id ID of the flexible IP for which to generate a virtual MAC
1010
mac-type TODO (unknown_type | vmware | xen | kvm)
1111
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1)
1212

‎cmd/scw/testdata/test-all-usage-fip-mac-delete-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Remove a virtual MAC from a Flexible IP.
3+
Detach a given MAC (Media Access Control) address from an existing flexible IP.
44

55
USAGE:
66
scw fip mac delete [arg=value ...]
77

88
ARGS:
9-
fip-id Flexible IP ID from which to delete the Virtual MAC
9+
fip-id ID of the flexible IP from which to delete the virtual MAC
1010
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1)
1111

1212
FLAGS:

0 commit comments

Comments
 (0)