implement deprecation message

.changes/unreleased/ENHANCEMENTS-20240515-100422.yaml

@@ -0,0 +1,6 @@
+kind: ENHANCEMENTS
+body: 'schema: Added `Description`, `MarkdownDescription` and `DeprecationMessage`
+  fields to resource, data source and provider schemas'
+time: 2024-05-15T10:04:22.078016-04:00
+custom:
+  Issue: "112"

internal/cmd/testdata/custom_and_external/ir.json

@@ -728,6 +728,7 @@
             }
           }
         ],
+        "deprecation_message": "This data source is deprecated!",
         "description": "\"Example\" datasource",
         "markdown_description": "\"Example\" _datasource_"
       }
@@ -1055,6 +1056,7 @@
           }
         }
       ],
+      "deprecation_message": "This provider is deprecated!",
       "description": "\"Example\" provider",
       "markdown_description": "\"Example\" _provider_"
     }
@@ -1435,6 +1437,7 @@
             }
           }
         ],
+        "deprecation_message": "This resource is deprecated!",
         "description": "\"Example\" resource",
         "markdown_description": "\"Example\" _resource_"
       }

internal/datasource/convert.go

@@ -61,6 +61,8 @@ func NewSchema(d datasource.DataSource) (generatorschema.GeneratorSchema, error)
 
 	s.MarkdownDescription = d.Schema.MarkdownDescription
 
+	s.DeprecationMessage = d.Schema.DeprecationMessage
+
 	return s, nil
 }
 

internal/provider/convert.go

@@ -64,6 +64,8 @@ func NewSchema(p *provider.Provider) (generatorschema.GeneratorSchema, error) {
 
 	s.MarkdownDescription = p.Schema.MarkdownDescription
 
+	s.DeprecationMessage = p.Schema.DeprecationMessage
+
 	return s, nil
 }
 

internal/resource/convert.go

@@ -61,6 +61,8 @@ func NewSchema(d resource.Resource) (generatorschema.GeneratorSchema, error) {
 
 	s.MarkdownDescription = d.Schema.MarkdownDescription
 
+	s.DeprecationMessage = d.Schema.DeprecationMessage
+
 	return s, nil
 }
 

internal/schema/schema.go

@@ -24,6 +24,7 @@ type GeneratorSchema struct {
 	Blocks              GeneratorBlocks
 	Description         *string
 	MarkdownDescription *string
+	DeprecationMessage  *string
 }
 
 func (g GeneratorSchema) Imports() (string, error) {
@@ -151,6 +152,11 @@ func (g GeneratorSchema) Schema(name, packageName, generatorType string) ([]byte
 		markdownDescription = *g.MarkdownDescription
 	}
 
+	deprecationMessage := ""
+	if g.DeprecationMessage != nil {
+		deprecationMessage = *g.DeprecationMessage
+	}
+
 	templateData := struct {
 		Name                string
 		PackageName         string
@@ -160,6 +166,7 @@ func (g GeneratorSchema) Schema(name, packageName, generatorType string) ([]byte
 		Description         string
 		Imports             string
 		MarkdownDescription string
+		DeprecationMessage  string
 	}{
 		Name:                FrameworkIdentifier(name).ToPascalCase(),
 		PackageName:         packageName,
@@ -169,6 +176,7 @@ func (g GeneratorSchema) Schema(name, packageName, generatorType string) ([]byte
 		Description:         description,
 		Imports:             imports,
 		MarkdownDescription: markdownDescription,
+		DeprecationMessage:  deprecationMessage,
 	}
 
 	t, err := template.New("schema").Parse(SchemaGoTemplate)

internal/schema/schemas.go

@@ -57,6 +57,7 @@ func (g GeneratorSchemas) Models() (map[string][]byte, error) {
 			Blocks:              schema.Blocks,
 			Description:         schema.Description,
 			MarkdownDescription: schema.MarkdownDescription,
+			DeprecationMessage:  schema.DeprecationMessage,
 		}
 
 		models, err := generatorSchema.Models(name)

internal/schema/templates/schema.gotmpl

@@ -31,5 +31,8 @@ return schema.Schema{
     {{- if .MarkdownDescription }}
 	MarkdownDescription: {{printf "%q" .MarkdownDescription}},
     {{- end}}
+    {{- if .DeprecationMessage }}
+	DeprecationMessage: {{printf "%q" .DeprecationMessage}},
+    {{- end}}
     }
 }