Docs update (using tfplugindocs tool) #92
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closed
zulh-civo
force-pushed
the
docs-update-tfplugindocs
branch
from
153983d to
97957c9
Compare
zulh-civo
changed the title
alejandrojnm
approved these changes
Sep 23, 2021
stack72
added a commit
to stack72/terraform-provider-civo
that referenced
this pull request
Oct 27, 2021
As part of civo#92, new "id" attributes were added to the schema for some of the resources. These are not actually needed since they are part of the plugin sdk by default. These parameters were not required before and "id" is something that is available on *ALL* TF based resources Because we (Pulumi) dervice our schema from your schema (and the plugin SDK) we are getting the following error: ``` sdk/python/bin/build/lib/pulumi_civo/dns_domain_name.py:218: error: Duplicate argument "id" in function definition ``` If the schema needed these, then the make build would fail but it still works ``` ▶ make build ==> Checking that code complies with gofmt requirements... go install ``` You can see from the internals of the plugin SDK (helper/schema/resource_data.go), the following func: ``` // SetId sets the ID of the resource. If the value is blank, then the // resource is destroyed. func (d *ResourceData) SetId(v string) { d.once.Do(d.init) d.newState.ID = v // once we transition away from the legacy state types, "id" will no longer // be a special field, and will become a normal attribute. // set the attribute normally d.setWriter.unsafeWriteField("id", v) // Make sure the newState is also set, otherwise the old value // may get precedence. if d.newState.Attributes == nil { d.newState.Attributes = map[string]string{} } d.newState.Attributes["id"] = v } ``` So when you use d.SetID, it actually creates the ID attribute for you
alejandrojnm
pushed a commit
that referenced
this pull request
Oct 27, 2021
As part of #92, new "id" attributes were added to the schema for some of the resources. These are not actually needed since they are part of the plugin sdk by default. These parameters were not required before and "id" is something that is available on *ALL* TF based resources Because we (Pulumi) dervice our schema from your schema (and the plugin SDK) we are getting the following error: ``` sdk/python/bin/build/lib/pulumi_civo/dns_domain_name.py:218: error: Duplicate argument "id" in function definition ``` If the schema needed these, then the make build would fail but it still works ``` ▶ make build ==> Checking that code complies with gofmt requirements... go install ``` You can see from the internals of the plugin SDK (helper/schema/resource_data.go), the following func: ``` // SetId sets the ID of the resource. If the value is blank, then the // resource is destroyed. func (d *ResourceData) SetId(v string) { d.once.Do(d.init) d.newState.ID = v // once we transition away from the legacy state types, "id" will no longer // be a special field, and will become a normal attribute. // set the attribute normally d.setWriter.unsafeWriteField("id", v) // Make sure the newState is also set, otherwise the old value // may get precedence. if d.newState.Attributes == nil { d.newState.Attributes = map[string]string{} } d.newState.Attributes["id"] = v } ``` So when you use d.SetID, it actually creates the ID attribute for you
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Replacement for #79
FYI: @saiyam1814 / @AnaisUrlichs