Skip to content

Conversation

@hfern
Copy link
Owner

@hfern hfern commented Aug 21, 2025

These fields are really only useful if you want to generate documentation from your schemas.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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, and deprecated parameters 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.

@hfern hfern merged commit e2b5e7e into hfern:master Aug 21, 2025
4 checks passed
@hfern hfern deleted the hgf/schema-descriptions branch August 21, 2025 16:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants