From 8f34320436208a83b33d8a102d56af5651e07cad Mon Sep 17 00:00:00 2001 From: "Jonas L." Date: Tue, 22 Oct 2024 15:12:49 +0200 Subject: [PATCH] docs: fix labels arguments and attributes for volumes and primary ips (#1016) The `labels` documentation was either missing or incorrect in some places for the primary ips and the volumes. --- website/docs/d/primary_ip.html.md | 2 +- website/docs/r/primary_ip.html.md | 4 ++-- website/docs/r/volume.html.md | 1 + 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/website/docs/d/primary_ip.html.md b/website/docs/d/primary_ip.html.md index 38f926194..6920d6f5f 100644 --- a/website/docs/d/primary_ip.html.md +++ b/website/docs/d/primary_ip.html.md @@ -65,7 +65,7 @@ resource "hcloud_server" "server_test" { - `name` - (string) Name of the Primary IP. - `datacenter` - (string) The datacenter name of the Primary IP. - `auto_delete` - (bool) Whether auto delete is enabled. -- `labels` - (string) Description of the Primary IP. +- `labels` - (map) User-defined labels (key-value pairs). - `ip_address` - (string) IP Address of the Primary IP. - `ip_network` - (string) IPv6 subnet of the Primary IP for IPv6 addresses. (Only set if `type` is `ipv6`) - `assignee_id` - (int) ID of the assigned resource. diff --git a/website/docs/r/primary_ip.html.md b/website/docs/r/primary_ip.html.md index a3f2b63cd..2cd0ce46f 100644 --- a/website/docs/r/primary_ip.html.md +++ b/website/docs/r/primary_ip.html.md @@ -49,7 +49,7 @@ resource "hcloud_server" "server_test" { - `datacenter` - (string, optional) The datacenter name to create the resource in. - `auto_delete` - (bool) Whether auto delete is enabled. `Important note:`It is recommended to set `auto_delete` to `false`, because if a server assigned to the managed ip is getting deleted, it will also delete the primary IP which will break the TF state. -- `labels` - (string) Description of the Primary IP. +- `labels` - (map, optional) User-defined labels (key-value pairs). - `assignee_id` - (int) ID of the assigned resource - `assignee_type` - (string) The type of the assigned resource. Currently supported: `server` - `delete_protection` - (bool) Whether delete protection is enabled. See ["Delete Protection"](../index.html.markdown#delete-protection) in the Provider Docs for details. @@ -62,7 +62,7 @@ resource "hcloud_server" "server_test" { - `name` - (string) Name of the Primary IP. - `auto_delete` - (bool) Whether auto delete is enabled. `Important note:`It is recommended to set `auto_delete` to `false`, because if a server assigned to a managed ip is getting deleted, it will also delete the primary IP which will break the TF state. -- `labels` - (string) Description of the Primary IP. +- `labels` - (map) User-defined labels (key-value pairs). - `ip_address` - (string) IP Address of the Primary IP. - `ip_network` - (string) IPv6 subnet of the Primary IP for IPv6 addresses. (Only set if `type` is `ipv6`) - `assignee_id` - (int) ID of the assigned resource diff --git a/website/docs/r/volume.html.md b/website/docs/r/volume.html.md index 524c07e70..ebaec1dbf 100644 --- a/website/docs/r/volume.html.md +++ b/website/docs/r/volume.html.md @@ -32,6 +32,7 @@ resource "hcloud_volume" "master" { - `name` - (Required, string) Name of the volume to create (must be unique per project). - `size` - (Required, int) Size of the volume (in GB). +- `labels` - (Optional, map) User-defined labels (key-value pairs). - `server_id` - (Optional, int) Server to attach the Volume to, not allowed if location argument is passed. - `location` - (Optional, string) The location name of the volume to create, not allowed if server_id argument is passed. - `automount` - (Optional, bool) Automount the volume upon attaching it (server_id must be provided).