Add resource-level description to specifications

Closes: #159
PaloAltoNetworks · Sep 24, 2024 · 222e2ff · 222e2ff
1 parent 73cfe3f
commit 222e2ff
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 0 deletions.
diff --git a/pkg/properties/normalized.go b/pkg/properties/normalized.go
@@ -65,6 +65,7 @@ const (
 )
 
 type TerraformProviderConfig struct {
+	Description           string                     `json:"description" yaml:"description"`
 	SkipResource          bool                       `json:"skip_resource" yaml:"skip_resource"`
 	SkipDatasource        bool                       `json:"skip_datasource" yaml:"skip_datasource"`
 	SkipDatasourceListing bool                       `json:"skip_datasource_listing" yaml:"skip_datasource_listing"`
@@ -528,6 +529,7 @@ func schemaToSpec(object object.Object) (*Normalization, error) {
 	spec := &Normalization{
 		Name: object.DisplayName,
 		TerraformProviderConfig: TerraformProviderConfig{
+			Description:           object.TerraformConfig.Description,
 			SkipResource:          object.TerraformConfig.SkipResource,
 			SkipDatasource:        object.TerraformConfig.SkipDatasource,
 			SkipDatasourceListing: object.TerraformConfig.SkipdatasourceListing,

diff --git a/pkg/schema/object/object.go b/pkg/schema/object/object.go
@@ -26,6 +26,7 @@ const (
 )
 
 type TerraformConfig struct {
+	Description           string                     `yaml:"description"`
 	SkipResource          bool                       `yaml:"skip_resource"`
 	SkipDatasource        bool                       `yaml:"skip_datasource"`
 	SkipdatasourceListing bool                       `yaml:"skip_datasource_listing"`

diff --git a/specs/schema/object.schema.json b/specs/schema/object.schema.json
@@ -20,6 +20,7 @@
       "additionalProperties": false,
       "required": ["suffix"],
       "properties": {
+        "description": { "type": "string" },
         "resource_type": {
           "type": "string",
           "enum": ["entry", "config", "uuid", "custom"]