From 45228094d3fd29a2533db626c137e722ed630442 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mario=20Sch=C3=A4fer?= Date: Fri, 13 May 2022 11:55:44 +0200 Subject: [PATCH] manual documentation additions as nested object property descriptions get lost see https://github.com/hashicorp/terraform-plugin-docs/issues/28#issuecomment-768299611 --- docs/data-sources/core_locations.md | 14 ++--- docs/data-sources/cpu_performance_types.md | 8 +-- docs/data-sources/disk_types.md | 10 ++-- docs/data-sources/dns_records.md | 16 +++--- docs/data-sources/dns_zones.md | 32 ++++++------ docs/data-sources/ip_addresses.md | 8 +-- docs/data-sources/tags.md | 4 +- docs/data-sources/template.md | 32 ++++++------ docs/data-sources/vlans.md | 6 +-- docs/data-sources/vsphere_locations.md | 14 ++--- docs/resources/network_prefix.md | 16 +++--- docs/resources/tag.md | 20 ++++---- docs/resources/virtual_server.md | 60 +++++++++++----------- docs/resources/vlan.md | 16 +++--- 14 files changed, 126 insertions(+), 130 deletions(-) diff --git a/docs/data-sources/core_locations.md b/docs/data-sources/core_locations.md index 8f96a6cc..d4d7d349 100644 --- a/docs/data-sources/core_locations.md +++ b/docs/data-sources/core_locations.md @@ -37,12 +37,12 @@ data "anxcloud_core_locations" "example" { Read-Only: -- `city_code` (String) -- `code` (String) -- `country` (String) -- `identifier` (String) -- `lat` (String) -- `lon` (String) -- `name` (String) +- `city_code` (String) Location city code. +- `code` (String) Location code. +- `country` (String) Location country. +- `identifier` (String) Location identifier. +- `lat` (String) Location latitude. +- `lon` (String) Location longitude. +- `name` (String) Location name. diff --git a/docs/data-sources/cpu_performance_types.md b/docs/data-sources/cpu_performance_types.md index dd499f2e..3c7b8d3a 100644 --- a/docs/data-sources/cpu_performance_types.md +++ b/docs/data-sources/cpu_performance_types.md @@ -32,9 +32,9 @@ data "anxcloud_cpu_performance_types" "example" {} Read-Only: -- `id` (String) -- `limit` (Number) -- `prioritization` (String) -- `unit` (String) +- `id` (String) CPU performance type identifier. +- `limit` (Number) CPU performance type limit. +- `prioritization` (String) CPU performance type prioritization. +- `unit` (String) CPU performance type limit unit. diff --git a/docs/data-sources/disk_types.md b/docs/data-sources/disk_types.md index 42d2f736..21a8106b 100644 --- a/docs/data-sources/disk_types.md +++ b/docs/data-sources/disk_types.md @@ -42,10 +42,10 @@ data "anxcloud_disk_types" "example" { Read-Only: -- `bandwidth` (Number) -- `id` (String) -- `iops` (Number) -- `latency` (Number) -- `storage_type` (String) +- `bandwidth` (Number) Disk type bandwidth. +- `id` (String) Disk type identifier. +- `iops` (Number) Disk type input/output operations per second. +- `latency` (Number) Disk type latency. +- `storage_type` (String) Disk type storage type. diff --git a/docs/data-sources/dns_records.md b/docs/data-sources/dns_records.md index 9199b05e..5bedb408 100644 --- a/docs/data-sources/dns_records.md +++ b/docs/data-sources/dns_records.md @@ -38,13 +38,13 @@ data "anxcloud_dns_records" "example" { Read-Only: -- `identifier` (String) -- `immutable` (Boolean) -- `name` (String) -- `rdata` (String) -- `region` (String) -- `ttl` (Number) -- `type` (String) -- `zone_name` (String) +- `identifier` (String) DNS Record identifier. Changes on revision change and therefore shouldn't be used as reference. +- `immutable` (Boolean) Specifies wheather or not a record is immutable. +- `name` (String) DNS record name. +- `rdata` (String) DNS record data. +- `region` (String) DNS record region (for GeoDNS aware records). +- `ttl` (Number) Region specific TTL. If not set the zone TTL will be used. +- `type` (String) DNS record type. +- `zone_name` (String) Zone of DNS record. diff --git a/docs/data-sources/dns_zones.md b/docs/data-sources/dns_zones.md index 0855bedf..79fb0d0c 100644 --- a/docs/data-sources/dns_zones.md +++ b/docs/data-sources/dns_zones.md @@ -32,27 +32,27 @@ data "anxcloud_dns_zones" "example" {} Read-Only: -- `admin_email` (String) -- `deployment_level` (Number) -- `dns_sec_mode` (String) -- `dns_servers` (List of Object) (see [below for nested schema](#nestedobjatt--zones--dns_servers)) -- `expire` (Number) -- `is_editable` (Boolean) -- `is_master` (Boolean) -- `master_nameserver` (String) -- `name` (String) -- `notify_allowed_ips` (List of String) -- `refresh` (Number) -- `retry` (Number) -- `ttl` (Number) -- `validation_level` (Number) +- `admin_email` (String) Admin email address. +- `deployment_level` (Number) Current deployment progress in percent. +- `dns_sec_mode` (String) DNSSec mode value for master zones. [`managed` or `unvalidated`] +- `dns_servers` (List of Object) (see [below for nested schema](#nestedobjatt--zones--dns_servers)) Configured DNS servers. +- `expire` (Number) Expiration value. +- `is_editable` (Boolean) Indicator if zone is editable. +- `is_master` (Boolean) Indicator if the zone is a master zone. +- `master_nameserver` (String) IP or domain of master nameserver. +- `name` (String) Zone name. +- `notify_allowed_ips` (List of String) IP addresses allowed to initiate domain transfer. +- `refresh` (Number) Refresh value. +- `retry` (Number) Retry value. +- `ttl` (Number) TTL value. +- `validation_level` (Number) Current validation level in percent. ### Nested Schema for `zones.dns_servers` Read-Only: -- `alias` (String) -- `server` (String) +- `alias` (String) DNS server alias. +- `server` (String) DNS server name. diff --git a/docs/data-sources/ip_addresses.md b/docs/data-sources/ip_addresses.md index 2c191725..e726af0a 100644 --- a/docs/data-sources/ip_addresses.md +++ b/docs/data-sources/ip_addresses.md @@ -37,9 +37,9 @@ data "anxcloud_ip_addresses" "example" { Read-Only: -- `address` (String) -- `description_customer` (String) -- `identifier` (String) -- `role` (String) +- `address` (String) Address identifier. +- `description_customer` (String) The IP address. +- `identifier` (String) Additional customer description. +- `role` (String) Role of the IP address. diff --git a/docs/data-sources/tags.md b/docs/data-sources/tags.md index d64b1bf4..5eea49c9 100644 --- a/docs/data-sources/tags.md +++ b/docs/data-sources/tags.md @@ -42,7 +42,7 @@ data "anxcloud_tags" "example" { Read-Only: -- `identifier` (String) -- `name` (String) +- `identifier` (String) Identifier of the tag. +- `name` (String) Name of the tag. diff --git a/docs/data-sources/template.md b/docs/data-sources/template.md index 445f40cf..9d8315ba 100644 --- a/docs/data-sources/template.md +++ b/docs/data-sources/template.md @@ -54,22 +54,22 @@ Read-Only: Read-Only: -- `boot_delay_seconds` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--boot_delay_seconds)) -- `cpus` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--cpus)) -- `disk_gb` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--disk_gb)) -- `disk_type` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--disk_type)) -- `dns0` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--dns0)) -- `dns1` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--dns1)) -- `dns2` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--dns2)) -- `dns3` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--dns3)) -- `enter_bios_setup` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--enter_bios_setup)) -- `hostname` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--hostname)) -- `ips` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--ips)) -- `memory_mb` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--memory_mb)) -- `nics` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--nics)) -- `password` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--password)) -- `user` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--user)) -- `vlan` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--vlan)) +- `boot_delay_seconds` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--boot_delay_seconds)) Boot delay parameter. +- `cpus` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--cpus)) CPUs parameter. +- `disk_gb` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--disk_gb)) Disk size parameter. +- `disk_type` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--disk_type)) Disk type parameter. +- `dns0` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--dns0)) DNS 0 parameter. +- `dns1` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--dns1)) DNS 1 parameter. +- `dns2` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--dns2)) DNS 2 parameter. +- `dns3` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--dns3)) DNS 3 parameter. +- `enter_bios_setup` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--enter_bios_setup)) Enter BIOS parameter. +- `hostname` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--hostname)) Hostname parameter. +- `ips` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--ips)) IPs parameter. +- `memory_mb` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--memory_mb)) Memory parameter. +- `nics` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--nics)) NICs parameter. +- `password` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--password)) Password parameter. +- `user` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--user)) User parameter. +- `vlan` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--vlan)) VLAN parameter. ### Nested Schema for `templates.params.boot_delay_seconds` diff --git a/docs/data-sources/vlans.md b/docs/data-sources/vlans.md index 7c710d74..e6de4504 100644 --- a/docs/data-sources/vlans.md +++ b/docs/data-sources/vlans.md @@ -37,8 +37,8 @@ data "anxcloud_vlans" "example" { Read-Only: -- `description_customer` (String) -- `identifier` (String) -- `name` (String) +- `description_customer` (String) Additional customer description. +- `identifier` (String) VLAN identifier. +- `name` (String) VLAN name. diff --git a/docs/data-sources/vsphere_locations.md b/docs/data-sources/vsphere_locations.md index 07fe909a..c1c860d4 100644 --- a/docs/data-sources/vsphere_locations.md +++ b/docs/data-sources/vsphere_locations.md @@ -39,12 +39,12 @@ data "anxcloud_vsphere_locations" "example" { Read-Only: -- `code` (String) -- `country` (String) -- `country_name` (String) -- `identifier` (String) -- `lat` (String) -- `lon` (String) -- `name` (String) +- `code` (String) Location code. +- `country` (String) Location country. +- `country_name` (String) Location country name. +- `identifier` (String) Location identifier. +- `lat` (String) Location latitude. +- `lon` (String) Location longitude. +- `name` (String) Location name. diff --git a/docs/resources/network_prefix.md b/docs/resources/network_prefix.md index 2a8a0da5..de9e70ad 100644 --- a/docs/resources/network_prefix.md +++ b/docs/resources/network_prefix.md @@ -74,12 +74,10 @@ Optional: Read-Only: -- `city_code` (String) -- `code` (String) -- `country` (String) -- `identifier` (String) -- `lat` (String) -- `lon` (String) -- `name` (String) - - +- `city_code` (String) Location city code. +- `code` (String) Location code. +- `country` (String) Location country. +- `identifier` (String) Location identifier. +- `lat` (String) Location latitude. +- `lon` (String) Location longitude. +- `name` (String) Location name. diff --git a/docs/resources/tag.md b/docs/resources/tag.md index 0bbc4066..4659e247 100644 --- a/docs/resources/tag.md +++ b/docs/resources/tag.md @@ -52,20 +52,20 @@ Optional: Read-Only: -- `customer` (List of Object) (see [below for nested schema](#nestedobjatt--organisation_assignments--customer)) -- `service` (List of Object) (see [below for nested schema](#nestedobjatt--organisation_assignments--service)) +- `customer` (List of Object) Customer related information. (see [below for nested schema](#nestedobjatt--organisation_assignments--customer)) +- `service` (List of Object) Service related information. (see [below for nested schema](#nestedobjatt--organisation_assignments--service)) ### Nested Schema for `organisation_assignments.customer` Read-Only: -- `customer_id` (String) -- `demo` (Boolean) -- `id` (String) -- `name` (String) -- `name_slug` (String) -- `reseller` (String) +- `customer_id` (String) Customer identifier. +- `demo` (Boolean) Whether is demo. +- `id` (String) Identifier. +- `name` (String) Customer name. +- `name_slug` (String) Slug name. +- `reseller` (String) Reseller name. @@ -73,7 +73,7 @@ Read-Only: Read-Only: -- `id` (String) -- `name` (String) +- `id` (String) Service identifier. +- `name` (String) Service name. diff --git a/docs/resources/virtual_server.md b/docs/resources/virtual_server.md index c28dda07..daa6d744 100644 --- a/docs/resources/virtual_server.md +++ b/docs/resources/virtual_server.md @@ -147,36 +147,36 @@ Optional: Read-Only: -- `cores` (Number) -- `cpu` (Number) -- `custom_name` (String) -- `disks_info` (List of Object) (see [below for nested schema](#nestedobjatt--info--disks_info)) -- `disks_number` (Number) -- `guest_os` (String) -- `guest_tools_status` (String) -- `identifier` (String) -- `location_code` (String) -- `location_country` (String) -- `location_name` (String) -- `name` (String) -- `network` (List of Object) (see [below for nested schema](#nestedobjatt--info--network)) -- `ram` (Number) -- `status` (String) -- `version_tools` (String) +- `cores` (Number) Number of CPU cores. +- `cpu` (Number) Number of CPUs. +- `custom_name` (String) Virtual server custom name. +- `disks_info` (List of Object) Disks info. (see [below for nested schema](#nestedobjatt--info--disks_info)) +- `disks_number` (Number) Number of the attached disks. +- `guest_os` (String) Guest operating system. +- `guest_tools_status` (String) Guest tools status. +- `identifier` (String) Virtual server identifier. +- `location_code` (String) Location code. +- `location_country` (String) Location country. +- `location_name` (String) Location name. +- `name` (String) Virtual server name. +- `network` (List of Object) Network interfaces. (see [below for nested schema](#nestedobjatt--info--network)) +- `ram` (Number) Memory in MB. +- `status` (String) Virtual server status. +- `version_tools` (String) Version tools. ### Nested Schema for `info.disks_info` Read-Only: -- `bus_type` (String) -- `bus_type_label` (String) -- `disk_gb` (Number) -- `disk_id` (Number) -- `disk_type` (String) -- `iops` (Number) -- `latency` (Number) -- `storage_type` (String) +- `bus_type` (String) Bus type. +- `bus_type_label` (String) Bus type label. +- `disk_gb` (Number) Size of the disk in GB. +- `disk_id` (Number) Disk identifier. +- `disk_type` (String) Disk type. +- `iops` (Number) Disk input/output operations per second. +- `latency` (Number) Disk latency. +- `storage_type` (String) Disk storage type. @@ -184,11 +184,11 @@ Read-Only: Read-Only: -- `id` (Number) -- `ip_v4` (List of String) -- `ip_v6` (List of String) -- `mac_address` (String) -- `nic` (Number) -- `vlan` (String) +- `id` (Number) Network interface card identifier. +- `ip_v4` (List of String) List of IPv4 addresses attached to the interface. +- `ip_v6` (List of String) List of IPv6 addresses attached to the interface. +- `mac_address` (String) MAC address of the NIC. +- `nic` (Number) NIC type number. +- `vlan` (String) VLAN identifier. diff --git a/docs/resources/vlan.md b/docs/resources/vlan.md index 0c38b08c..110286f6 100644 --- a/docs/resources/vlan.md +++ b/docs/resources/vlan.md @@ -61,12 +61,10 @@ Optional: Read-Only: -- `city_code` (String) -- `code` (String) -- `country` (String) -- `identifier` (String) -- `lat` (String) -- `lon` (String) -- `name` (String) - - +- `city_code` (String) Location city code. +- `code` (String) Location code. +- `country` (String) Location country. +- `identifier` (String) Location identifier. +- `lat` (String) Location latitude. +- `lon` (String) Location longitude. +- `name` (String) Location name.