Skip to content

Commit ed6475d

Browse files
authored
docs(flexible-ip): update docs (#3125)
1 parent 925eeff commit ed6475d

File tree

2 files changed

+8
-16
lines changed

2 files changed

+8
-16
lines changed

docs/data-sources/flexible_ip.md

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,33 +11,26 @@ Gets information about a Flexible IP.
1111

1212
```hcl
1313
# Get info by IP address
14-
data "scaleway_flexible_ip" "my_ip" {
14+
data "scaleway_flexible_ip" "with_ip" {
1515
ip_address = "1.2.3.4"
1616
}
1717
1818
# Get info by IP ID
19-
data "scaleway_flexible_ip" "my_ip" {
20-
ip_id = "11111111-1111-1111-1111-111111111111"
19+
data "scaleway_flexible_ip" "with_id" {
20+
flexible_ip_id = "11111111-1111-1111-1111-111111111111"
2121
}
2222
```
2323

2424
## Argument Reference
2525

2626
- `ip_address` - (Optional) The IP address.
27-
Only one of `ip_address` and `ip_id` should be specified.
27+
Only one of `ip_address` and `flexible_ip_id` should be specified.
2828

2929
- `flexible_ip_id` - (Optional) The IP ID.
3030
Only one of `ip_address` and `flexible_ip_id` should be specified.
3131

32-
## Attributes Reference
33-
34-
In addition to all above arguments, the following attributes are exported:
32+
- `project_id` - (Optional. Defaults to [provider](../index.md#project_id) `project_id`) The ID of the Project the Flexible IP is associated with.
3533

36-
- `id` - The ID of the flexible IP.
37-
38-
~> **Important:** Flexible IPs' IDs are [zoned](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111`
34+
## Attributes Reference
3935

40-
- `reverse` - The reverse domain associated with this IP.
41-
- `server_id` - The associated server ID if any
42-
- `organization_id` - (Defaults to [provider](../index.md#organization_id) `organization_id`) The ID of the organization the IP is in.
43-
- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the IP is in.
36+
Exported attributes are the ones from `flexible_ip` [resource](../resources/flexible_ip.md)

docs/resources/flexible_ip.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ The following arguments are supported:
7878
- `reverse` - (Optional) The reverse domain associated with this flexible IP.
7979
- `is_ipv6` - (Optional) Defines whether the flexible IP has an IPv6 address.
8080
- `zone` -(Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) of the Flexible IP.
81-
81+
- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the Project the Flexible IP is associated with.
8282

8383
## Attributes Reference
8484

@@ -94,7 +94,6 @@ In addition to all arguments above, the following attributes are exported:
9494
- `created_at` - The date and time of the creation of the Flexible IP (Format ISO 8601).
9595
- `updated_at` - The date and time of the last update of the Flexible IP (Format ISO 8601).
9696
- `organization_id` - The organization of the Flexible IP.
97-
- `project_id` - The project of the Flexible IP.
9897

9998
## Import
10099

0 commit comments

Comments
 (0)