ResiLien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #26836 from hashicorp/terraform-provider-descriptions 

builtin/provider/terraform: Add field descriptions
This commit is contained in:
Radek Simko 2020-11-07 10:33:41 +00:00 committed by GitHub
parent 2d301f1fb3 bc87be384b
commit d011d0d507
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
builtin/providers/terraform/data_source_state.go
View File

@ -18,24 +18,42 @@ func dataSourceRemoteStateGetSchema() providers.Schema {
Block: &configschema.Block{
Attributes: map[string]*configschema.Attribute{
"backend": {
Type: cty.String,
Required: true,
Type: cty.String,
Description: "The remote backend to use, e.g. `remote` or `http`.",
DescriptionKind: configschema.StringMarkdown,
Required: true,
},
"config": {
Type: cty.DynamicPseudoType,
Optional: true,
Type: cty.DynamicPseudoType,
Description: "The configuration of the remote backend. " +
"Although this is optional, most backends require " +
"some configuration.\n\n" +
"The object can use any arguments that would be valid " +
"in the equivalent `terraform { backend \"<TYPE>\" { ... } }` " +
"block.",
DescriptionKind: configschema.StringMarkdown,
Optional: true,
},
"defaults": {
Type: cty.DynamicPseudoType,
Optional: true,
Type: cty.DynamicPseudoType,
Description: "Default values for outputs, in case " +
"the state file is empty or lacks a required output.",
DescriptionKind: configschema.StringMarkdown,
Optional: true,
},
"outputs": {
Type: cty.DynamicPseudoType,
Computed: true,
Type: cty.DynamicPseudoType,
Description: "An object containing every root-level " +
"output in the remote state.",
DescriptionKind: configschema.StringMarkdown,
Computed: true,
},
"workspace": {
Type: cty.String,
Optional: true,
Type: cty.String,
Description: "The Terraform workspace to use, if " +
"the backend supports workspaces.",
DescriptionKind: configschema.StringMarkdown,
Optional: true,
},
},
},