Skip to content

update types.mdx #547

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
vravind1 wants to merge 2 commits into from
Closed

update types.mdx #547

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b8ad709
update types.mdx
vravind1 Nov 18, 2022
061b5c1
Update types.mdx
vravind1 Nov 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions website/docs/plugin/framework/types.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ Call one of the following to create a `types.Bool`:

Lists are ordered collections of a single element type.

-> Use [ListNestedAttributes](/plugin/framework/schemas#ListNestedAttributes) for lists of objects that need additional schema information. Use [SetType and Set](#settype-and-set) for unordered collections.
-> Use [ListNestedAttributes](/plugin/framework/schemas#listnestedattributes) for lists of objects that need additional schema information. Use [SetType and Set](#settype-and-set) for unordered collections.

Given an example Terraform configuration that sets a list of string values to the `example_attribute` attribute:

Expand Down Expand Up @@ -292,7 +292,7 @@ Call one of the following to create a `types.List`:

Maps are mappings of string keys to values of a single element type.

-> Use [MapNestedAttributes](/plugin/framework/schemas#MapNestedAttributes) for maps of objects that need additional schema information. Use [ObjectType and Object](#objecttype-and-object) for structures of string attribute names to any value.
-> Use [MapNestedAttributes](/plugin/framework/schemas#mapnestedattributes) for maps of objects that need additional schema information. Use [ObjectType and Object](#objecttype-and-object) for structures of string attribute names to any value.

Given an example Terraform configuration that sets a map of string values to the `example_attribute` attribute:

Expand Down Expand Up @@ -336,7 +336,7 @@ Call one of the following to create a `types.Map`:

Objects are mappings of string attribute names to values of any type. Objects must always declare all attribute values, even when those attributes are null or unknown, unless the entire object is null or unknown.

-> Use [SingleNestedAttributes](/plugin/framework/schemas#SingleNestedAttributes) for objects that need additional schema information. Use [MapType and Map](#maptype-and-map) for mappings of string keys to a single element type.
-> Use [SingleNestedAttributes](/plugin/framework/schemas#singlenestedattributes) for objects that need additional schema information. Use [MapType and Map](#maptype-and-map) for mappings of string keys to a single element type.

Given an example Terraform configuration that sets a map of string values to the `example_attribute` attribute:

Expand Down Expand Up @@ -384,7 +384,7 @@ Call one of the following to create a `types.Object`:

Set are unordered, unique collections of a single element type.

-> Use [SetNestedAttributes](/plugin/framework/schemas#SetNestedAttributes) for sets of objects that need additional schema information. Use [ListType and List](#listtype-and-list) for ordered collections.
-> Use [SetNestedAttributes](/plugin/framework/schemas#setnestedattributes) for sets of objects that need additional schema information. Use [ListType and List](#listtype-and-list) for ordered collections.
Copy link
Contributor

@bendbennett bendbennett Nov 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a SetNestedAttributes section in the schemas page?

Copy link
Member Author

@vravind1 vravind1 Nov 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oops, I missed it. should we create one here? as there is a link in types page


Given an example Terraform configuration that sets a set of string values to the `example_attribute` attribute:

Expand Down