Merge pull request #714 from Juniper/679-documentation

Fix documentation for `name` and `id` attributes of `apstra_property_set` resource
Juniper · Jul 12, 2024 · 6ae1b78 · 6ae1b78
2 parents f5350e9 + bc918b0
commit 6ae1b78
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/apstra/design/property_set.go b/apstra/design/property_set.go
@@ -64,14 +64,14 @@ func (o PropertySet) DataSourceAttributes() map[string]dataSourceSchema.Attribut
 func (o PropertySet) ResourceAttributes() map[string]resourceSchema.Attribute {
 	return map[string]resourceSchema.Attribute{
 		"id": resourceSchema.StringAttribute{
-			MarkdownDescription: "Populate this field to look up a Property Set by ID. Required when `name` is omitted.",
+			MarkdownDescription: "Apstra ID number of the Property Set.",
 			Computed:            true,
 			PlanModifiers: []planmodifier.String{
 				stringplanmodifier.UseStateForUnknown(),
 			},
 		},
 		"name": resourceSchema.StringAttribute{
-			MarkdownDescription: "Populate this field to look up a Property Set by name. Required when `id` is omitted.",
+			MarkdownDescription: "Name of the Property Set.",
 			Required:            true,
 			Validators:          []validator.String{stringvalidator.LengthAtLeast(1)},
 		},

diff --git a/docs/resources/property_set.md b/docs/resources/property_set.md
@@ -41,12 +41,12 @@ resource "apstra_property_set" "r" {
 ### Required
 
 - `data` (String) A map of values in the Property Set in JSON format
-- `name` (String) Populate this field to look up a Property Set by name. Required when `id` is omitted.
+- `name` (String) Name of the Property Set.
 
 ### Read-Only
 
 - `blueprints` (Set of String) Set of blueprints that this Property Set might be associated with.
-- `id` (String) Populate this field to look up a Property Set by ID. Required when `name` is omitted.
+- `id` (String) Apstra ID number of the Property Set.
 - `keys` (Set of String) Set of keys defined in the Property Set.