Allow Schemas/Blocks to specify description(kind) and deprecated#12
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for description and deprecation metadata to Schema and Block classes in the Terraform plugin framework. It enables resource types, data sources, and providers to specify documentation descriptions with formatting options (Markdown or Plain text) and deprecation status.
- Added
description,description_kind, anddeprecatedparameters to Schema and Block constructors - Updated protobuf serialization to include these new fields with proper default handling
- Added comprehensive test coverage for the new functionality
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| tf/schema.py | Added description and deprecation fields to Schema and Block classes with protobuf serialization |
| tf/tests/test_schema.py | Added test cases for description formatting and deprecation functionality |
| CHANGELOG.md | Documented the new feature addition |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
rrodriguez-hms
approved these changes
Aug 21, 2025
ralphie0112358
approved these changes
Aug 21, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
These fields are really only useful if you want to generate documentation from your schemas.