Upgrade terraform-plugin-docs to v0.11.0

CHANGELOG.md

@@ -26,6 +26,7 @@ If the change isn't user-facing but still relevant enough for a changelog entry,
 
 ### Fixed
 * resource/anxcloud_virtual_server: tags changed outside of terraform will now get reverted back to terraform config on apply (#101, @marioreggiori)
+* docs: implicit `id` fields of data sources are now rendered as read-only instead of optional (#103, @marioreggiori)
 
 ### Added
 * tagging capabilities to supported resources (#101, @marioreggiori)

docs/data-sources/core_location.md

@@ -24,12 +24,12 @@ data "anxcloud_core_location" "anx04" {
 ### Optional
 
 - `code` (String) Location code.
-- `id` (String) The ID of this resource.
 
 ### Read-Only
 
 - `city_code` (String) Location city code.
 - `country` (String) Location country.
+- `id` (String) The ID of this resource.
 - `identifier` (String) Identifier of the API resource.
 - `lat` (String) Location latitude.
 - `lon` (String) Location longitude.

docs/data-sources/core_locations.md

@@ -23,11 +23,11 @@ data "anxcloud_core_locations" "example" {
 
 ### Optional
 
-- `id` (String) The ID of this resource.
 - `search` (String) An optional string allowing to search through entities.
 
 ### Read-Only
 
+- `id` (String) The ID of this resource.
 - `locations` (List of Object) Anexia Cloud Locations. (see [below for nested schema](#nestedatt--locations))
 
 <a id="nestedatt--locations"></a>

docs/data-sources/cpu_performance_types.md

@@ -19,12 +19,9 @@ data "anxcloud_cpu_performance_types" "example" {}
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
-### Optional
-
-- `id` (String) The ID of this resource.
-
 ### Read-Only
 
+- `id` (String) The ID of this resource.
 - `types` (List of Object) List of CPU performance types. (see [below for nested schema](#nestedatt--types))
 
 <a id="nestedatt--types"></a>

docs/data-sources/disk_types.md

@@ -29,12 +29,9 @@ data "anxcloud_disk_types" "example" {
 
 - `location_id` (String) Location identifier.
 
-### Optional
-
-- `id` (String) The ID of this resource.
-
 ### Read-Only
 
+- `id` (String) The ID of this resource.
 - `types` (List of Object) List of available disk types. (see [below for nested schema](#nestedatt--types))
 
 <a id="nestedatt--types"></a>

docs/data-sources/dns_records.md

@@ -25,12 +25,9 @@ data "anxcloud_dns_records" "example" {
 
 - `zone_name` (String) Parent zone
 
-### Optional
-
-- `id` (String) The ID of this resource.
-
 ### Read-Only
 
+- `id` (String) The ID of this resource.
 - `records` (List of Object) List of known records on the zone (see [below for nested schema](#nestedatt--records))
 
 <a id="nestedatt--records"></a>

docs/data-sources/dns_zones.md

@@ -19,12 +19,9 @@ data "anxcloud_dns_zones" "example" {}
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
-### Optional
-
-- `id` (String) The ID of this resource.
-
 ### Read-Only
 
+- `id` (String) The ID of this resource.
 - `zones` (List of Object) List of DNS zones of the customer. (see [below for nested schema](#nestedatt--zones))
 
 <a id="nestedatt--zones"></a>

docs/data-sources/ip_addresses.md

@@ -23,12 +23,12 @@ data "anxcloud_ip_addresses" "example" {
 
 ### Optional
 
-- `id` (String) The ID of this resource.
 - `search` (String) An optional string allowing to search through entities.
 
 ### Read-Only
 
 - `addresses` (List of Object) List of available addresses. (see [below for nested schema](#nestedatt--addresses))
+- `id` (String) The ID of this resource.
 
 <a id="nestedatt--addresses"></a>
 ### Nested Schema for `addresses`

docs/data-sources/nic_types.md

@@ -19,12 +19,9 @@ data "anxcloud_nic_types" "example" {}
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
-### Optional
-
-- `id` (String) The ID of this resource.
-
 ### Read-Only
 
+- `id` (String) The ID of this resource.
 - `nic_types` (List of String) List of available nic types.
 
 

docs/data-sources/tags.md

@@ -24,7 +24,6 @@ data "anxcloud_tags" "example" {
 
 ### Optional
 
-- `id` (String) The ID of this resource.
 - `order` (String) The order of the tags.
 - `organization_identifier` (String) The identifier of the organization.
 - `query` (String) An optional string allowing to search through entities.
@@ -33,6 +32,7 @@ data "anxcloud_tags" "example" {
 
 ### Read-Only
 
+- `id` (String) The ID of this resource.
 - `tags` (List of Object) List of tags. (see [below for nested schema](#nestedatt--tags))
 
 <a id="nestedatt--tags"></a>

docs/data-sources/template.md

@@ -40,11 +40,11 @@ locals {
 
 ### Optional
 
-- `id` (String) The ID of this resource.
 - `template_type` (String) Template type. Defaults to 'templates' and also supports 'from_scratch'.
 
 ### Read-Only
 
+- `id` (String) The ID of this resource.
 - `templates` (List of Object) List of available templates. (see [below for nested schema](#nestedatt--templates))
 
 <a id="nestedatt--templates"></a>

docs/data-sources/vlans.md

@@ -23,11 +23,11 @@ data "anxcloud_vlans" "example" {
 
 ### Optional
 
-- `id` (String) The ID of this resource.
 - `search` (String) An optional string allowing to search through entities.
 
 ### Read-Only
 
+- `id` (String) The ID of this resource.
 - `vlans` (List of Object) List of available VLANs. (see [below for nested schema](#nestedatt--vlans))
 
 <a id="nestedatt--vlans"></a>

docs/data-sources/vsphere_locations.md

@@ -26,14 +26,14 @@ data "anxcloud_vsphere_locations" "example" {
 
 ### Optional
 
-- `id` (String) The ID of this resource.
 - `limit` (Number) The limit of the list.
 - `location_code` (String) Filters locations by country code
 - `organization` (String) Customer identifier
 - `page` (Number) The page of the list.
 
 ### Read-Only
 
+- `id` (String) The ID of this resource.
 - `locations` (List of Object) Anexia Cloud Locations. (see [below for nested schema](#nestedatt--locations))
 
 <a id="nestedatt--locations"></a>

docs/resources/dns_record.md

@@ -34,12 +34,12 @@ resource "anxcloud_dns_record" "example" {
 
 ### Optional
 
-- `id` (String) The ID of this resource.
 - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
 - `ttl` (Number) Region specific TTL. If not set the zone TTL will be used.
 
 ### Read-Only
 
+- `id` (String) The ID of this resource.
 - `identifier` (String) DNS Record identifier. Changes on revision change and therefore shouldn't be used as reference.
 - `immutable` (Boolean) Specifies whether or not a record is immutable.
 - `region` (String) DNS record region (for GeoDNS aware records).

docs/resources/dns_zone.md

@@ -42,14 +42,14 @@ resource "anxcloud_dns_zone" "example" {
 ### Optional
 
 - `dns_servers` (Block List) Configured DNS servers. (see [below for nested schema](#nestedblock--dns_servers))
-- `id` (String) The ID of this resource.
 - `master_nameserver` (String) Master nameserver.
 - `notify_allowed_ips` (List of String) IP addresses allowed to initiate domain transfer.
 - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
 
 ### Read-Only
 
 - `deployment_level` (Number) Current deployment progress in percent.
+- `id` (String) The ID of this resource.
 - `is_editable` (Boolean) Indicator if zone is editable.
 - `validation_level` (Number) Current validation level in percent.
 

docs/resources/network_prefix.md

@@ -42,7 +42,6 @@ resource "anxcloud_network_prefix" "example" {
 
 - `create_empty` (Boolean) Whether the prefix should be created with inactive IPs
 - `description_customer` (String) Additional description.
-- `id` (String) The ID of this resource.
 - `ip_version` (Number) The Prefix version: 4 = IPv4, 6 = IPv6.
 - `organization` (String) Customer of yours. Reseller only.
 - `router_redundancy` (Boolean) If router Redundancy shall be enabled.
@@ -55,6 +54,7 @@ resource "anxcloud_network_prefix" "example" {
 
 - `cidr` (String) CIDR of the created prefix.
 - `description_internal` (String) Internal description.
+- `id` (String) The ID of this resource.
 - `locations` (List of Object) Anexia Cloud Locations. (see [below for nested schema](#nestedatt--locations))
 - `role_text` (String) Role of the prefix.
 - `status` (String) Status of the created prefix.

docs/resources/tag.md

@@ -30,11 +30,11 @@ resource "anxcloud_tag" "example" {
 ### Optional
 
 - `customer_id` (String) The identifier of the customer this tag should be assigned to. Leave empty to assign to the organization of the logged in user.
-- `id` (String) The ID of this resource.
 - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
 
 ### Read-Only
 
+- `id` (String) The ID of this resource.
 - `organisation_assignments` (List of Object) Organisation assignments. (see [below for nested schema](#nestedatt--organisation_assignments))
 
 <a id="nestedblock--timeouts"></a>

docs/resources/virtual_server.md

@@ -114,7 +114,6 @@ resource "anxcloud_virtual_server" "example" {
 - `dns` (List of String) DNS configuration. Maximum items 4. Defaults to template settings.
 - `enter_bios_setup` (Boolean) Start the VM into BIOS setup on next boot.
 - `force_restart_if_needed` (Boolean) Certain operations may only be performed in powered off state. Such as: shrinking memory, shrinking/adding CPU, removing disk and scaling a disk beyond 2 GB. Passing this value as true will always execute a power off and reboot request after completing all other operations. Without this flag set to true scaling operations requiring a reboot will fail.
-- `id` (String) The ID of this resource.
 - `network` (Block List) Network interface (see [below for nested schema](#nestedblock--network))
 - `password` (String, Sensitive) Plaintext password. Example: ('!anx123mySuperStrongPassword123anx!', 'go3ju0la1ro3', …). For systems that support it, we strongly recommend using a SSH key instead.
 - `script` (String) Script to be executed after provisioning. Consider the corresponding shebang at the beginning of your script. If you want to use PowerShell, the first line should be: #ps1_sysnative.
@@ -129,6 +128,7 @@ resource "anxcloud_virtual_server" "example" {
 
 ### Read-Only
 
+- `id` (String) The ID of this resource.
 - `info` (List of Object) Virtual server info (see [below for nested schema](#nestedatt--info))
 
 <a id="nestedblock--disk"></a>

docs/resources/vlan.md

@@ -33,14 +33,14 @@ resource "anxcloud_vlan" "example" {
 ### Optional
 
 - `description_customer` (String) Additional customer description.
-- `id` (String) The ID of this resource.
 - `tags` (List of String) List of tags attached to the resource.
 - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
 - `vm_provisioning` (Boolean) True if VM provisioning shall be enabled. Defaults to false.
 
 ### Read-Only
 
 - `description_internal` (String) Internal description.
+- `id` (String) The ID of this resource.
 - `locations` (List of Object) Anexia Cloud Locations. (see [below for nested schema](#nestedatt--locations))
 - `name` (String) VLAN name.
 - `role_text` (String) Role of the VLAN.

tools/go.mod

@@ -5,13 +5,13 @@ go 1.18
 require (
 	github.com/client9/misspell v0.3.4
 	github.com/golangci/golangci-lint v1.46.2
+	github.com/hashicorp/terraform-plugin-docs v0.11.0
 	github.com/katbyte/terrafmt v0.4.0
 )
 
 require (
 	github.com/GaijinEntertainment/go-exhaustruct/v2 v2.1.0 // indirect
-	github.com/Masterminds/goutils v1.1.0 // indirect
-	github.com/Masterminds/sprig v2.22.0+incompatible // indirect
+	github.com/Masterminds/goutils v1.1.1 // indirect
 	github.com/agext/levenshtein v1.2.3 // indirect
 	github.com/andreyvit/diff v0.0.0-20170406064948-c7f18ee00883 // indirect
 	github.com/apparentlymart/go-textseg/v12 v12.0.0 // indirect
@@ -22,13 +22,13 @@ require (
 	github.com/firefart/nonamedreturns v1.0.1 // indirect
 	github.com/google/uuid v1.3.0 // indirect
 	github.com/gookit/color v1.5.0 // indirect
-	github.com/hashicorp/hc-install v0.3.1 // indirect
+	github.com/hashicorp/hc-install v0.4.0 // indirect
 	github.com/hashicorp/hcl/v2 v2.6.0 // indirect
 	github.com/hexops/gotextdiff v1.0.3 // indirect
 	github.com/huandu/xstrings v1.3.2 // indirect
-	github.com/imdario/mergo v0.3.12 // indirect
+	github.com/imdario/mergo v0.3.13 // indirect
 	github.com/lufeee/execinquery v1.2.1 // indirect
-	github.com/mitchellh/cli v1.1.2 // indirect
+	github.com/mitchellh/cli v1.1.4 // indirect
 	github.com/mitchellh/copystructure v1.2.0 // indirect
 	github.com/mitchellh/go-wordwrap v1.0.0 // indirect
 	github.com/mitchellh/reflectwalk v1.0.2 // indirect
@@ -50,6 +50,8 @@ require (
 	github.com/BurntSushi/toml v1.1.0 // indirect
 	github.com/Djarvur/go-err113 v0.0.0-20210108212216-aea10b59be24 // indirect
 	github.com/Masterminds/semver v1.5.0 // indirect
+	github.com/Masterminds/semver/v3 v3.1.1 // indirect
+	github.com/Masterminds/sprig/v3 v3.2.2 // indirect
 	github.com/OpenPeeDeeP/depguard v1.1.0 // indirect
 	github.com/alexkohler/prealloc v1.0.0 // indirect
 	github.com/ashanbrown/forbidigo v1.3.0 // indirect
@@ -93,7 +95,7 @@ require (
 	github.com/golangci/misspell v0.3.5 // indirect
 	github.com/golangci/revgrep v0.0.0-20210930125155-c22e5001d4f2 // indirect
 	github.com/golangci/unconvert v0.0.0-20180507085042-28b1c447d1f4 // indirect
-	github.com/google/go-cmp v0.5.7 // indirect
+	github.com/google/go-cmp v0.5.8 // indirect
 	github.com/gordonklaus/ineffassign v0.0.0-20210914165742-4cc7213b9bc8 // indirect
 	github.com/gostaticanalysis/analysisutil v0.7.1 // indirect
 	github.com/gostaticanalysis/comment v1.4.2 // indirect
@@ -103,12 +105,11 @@ require (
 	github.com/hashicorp/go-checkpoint v0.5.0 // indirect
 	github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
 	github.com/hashicorp/go-multierror v1.1.1 // indirect
-	github.com/hashicorp/go-uuid v1.0.2 // indirect
-	github.com/hashicorp/go-version v1.4.0 // indirect
+	github.com/hashicorp/go-uuid v1.0.3 // indirect
+	github.com/hashicorp/go-version v1.6.0 // indirect
 	github.com/hashicorp/hcl v1.0.0 // indirect
-	github.com/hashicorp/terraform-exec v0.16.0 // indirect
-	github.com/hashicorp/terraform-json v0.13.0 // indirect
-	github.com/hashicorp/terraform-plugin-docs v0.7.0
+	github.com/hashicorp/terraform-exec v0.17.1 // indirect
+	github.com/hashicorp/terraform-json v0.14.0 // indirect
 	github.com/inconshreveable/mousetrap v1.0.0 // indirect
 	github.com/jgautheron/goconst v1.5.1 // indirect
 	github.com/jingyugao/rowserrcheck v1.1.1 // indirect
@@ -156,13 +157,14 @@ require (
 	github.com/sanposhiho/wastedassign/v2 v2.0.6 // indirect
 	github.com/securego/gosec/v2 v2.11.0 // indirect
 	github.com/shazow/go-diff v0.0.0-20160112020656-b6b7b6733b8c // indirect
+	github.com/shopspring/decimal v1.3.1 // indirect
 	github.com/sirupsen/logrus v1.8.1 // indirect
 	github.com/sivchari/containedctx v1.0.2 // indirect
 	github.com/sivchari/tenv v1.5.0 // indirect
 	github.com/sonatard/noctx v0.0.1 // indirect
 	github.com/sourcegraph/go-diff v0.6.1 // indirect
 	github.com/spf13/afero v1.8.2 // indirect
-	github.com/spf13/cast v1.4.1 // indirect
+	github.com/spf13/cast v1.5.0 // indirect
 	github.com/spf13/cobra v1.4.0 // indirect
 	github.com/spf13/jwalterweatherman v1.1.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
@@ -184,16 +186,16 @@ require (
 	github.com/yeya24/promlinter v0.2.0 // indirect
 	github.com/zclconf/go-cty v1.10.0 // indirect
 	gitlab.com/bosi/decorder v0.2.1 // indirect
-	golang.org/x/crypto v0.0.0-20220411220226-7b82a4e95df4 // indirect
+	golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d // indirect
 	golang.org/x/mod v0.6.0-dev.0.20220106191415-9b9b3d81d5e3 // indirect
-	golang.org/x/sys v0.0.0-20220422013727-9388b58f7150 // indirect
+	golang.org/x/sys v0.0.0-20220627191245-f75cf1eec38b // indirect
 	golang.org/x/text v0.3.7 // indirect
 	golang.org/x/tools v0.1.11-0.20220316014157-77aa08bb151a // indirect
 	golang.org/x/xerrors v0.0.0-20220411194840-2f41105eb62f // indirect
 	google.golang.org/protobuf v1.28.0 // indirect
 	gopkg.in/ini.v1 v1.66.4 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
-	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
+	gopkg.in/yaml.v3 v3.0.0 // indirect
 	honnef.co/go/tools v0.3.1 // indirect
 	mvdan.cc/gofumpt v0.3.1 // indirect
 	mvdan.cc/interfacer v0.0.0-20180901003855-c20040233aed // indirect