Generate descriptions for maps and lists in terraform

PaloAltoNetworks · Aug 30, 2024 · 0ff9005 · 0ff9005
1 parent f6fdfe0
commit 0ff9005
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/golangci/golangci-lint/
-    rev: v1.59.1
+    rev: v1.60.3
     hooks:
       - id: golangci-lint
   - repo: https://github.com/pre-commit/pre-commit-hooks

diff --git a/pkg/translate/terraform_provider/funcs.go b/pkg/translate/terraform_provider/funcs.go
@@ -1293,6 +1293,7 @@ func createSchemaSpecForNormalization(resourceTyp properties.ResourceType, schem
 const renderSchemaTemplate = `
 {{- define "renderSchemaListAttribute" }}
 	"{{ .Name.Underscore }}": {{ .Package }}.{{ .SchemaType }} {
+		Description: "{{ .Description }}",
 		Required: {{ .Required }},
 		Optional: {{ .Optional }},
 		Computed: {{ .Computed }},
@@ -1303,6 +1304,7 @@ const renderSchemaTemplate = `
 
 {{- define "renderSchemaMapAttribute" }}
 	"{{ .Name.Underscore }}": {{ .Package }}.{{ .SchemaType }} {
+		Description: "{{ .Description }}",
 		Required: {{ .Required }},
 		Optional: {{ .Optional }},
 		Computed: {{ .Computed }},
@@ -1314,6 +1316,7 @@ const renderSchemaTemplate = `
 {{- define "renderSchemaListNestedAttribute" }}
   {{- with .Attribute }}
 	"{{ .Name.Underscore }}": {{ .Package }}.{{ .SchemaType }} {
+		Description: "{{ .Description }}",
 		Required: {{ .Required }},
 		Optional: {{ .Optional }},
 		Computed: {{ .Computed }},
@@ -1386,6 +1389,7 @@ const renderSchemaTemplate = `
 func {{ .StructName }}Schema() {{ .Package }}.{{ .ReturnType }} {
 	return {{ .Package }}.{{ .ReturnType }}{
 {{- if not (or (eq .ReturnType "Schema") (eq .ReturnType "NestedAttributeObject")) }}
+		Description: "{{ .Description }}",
 		Required: {{ .Required }},
 		Computed: {{ .Computed }},
 		Optional: {{ .Optional }},