feat: extract schema-level descriptions from OpenAPI tags #295
Conversation
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
This adds support for extracting resource and data source descriptions from the OpenAPI tags section. When an operation has tags, the description of the first matching tag from the document's tags array is used as the schema-level description. This addresses the feature request in issue hashicorp#123. Changes: - Add Description field to explorer.Resource and explorer.DataSource - Add helper functions getTagDescription and getOperationTagDescription - Update resource_mapper.go to set resourceSchema.Description - Update datasource_mapper.go to set dataSourceSchema.Description - Regenerate golden test files
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This adds support for extracting resource and data source descriptions from the OpenAPI tags section. When an operation has tags, the description of the first matching tag from the document's tags array is used as the schema-level description.
This addresses the feature request in issue #123.
Changes: