internal/fwschema: Introduce NestedAttribute interface and cleanup Attribute interface methods #543
Conversation
This file contains 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
…tribute interface methods Reference: #132 As part of upcoming effort to split schema functionality into the `datasource`, `provider`, and `resource` packages, there are some internal implementation details which need to be sorted beforehand. Throughout the 0.x versions, schema functionality has been migrated from the `tfsdk` package into the `internal/fwschema` package, but there is some lingering technical debt of duplicate and confusing methods. This change creates a new `NestedAttribute` (singular) interface which extends the `Attribute` interface with the methods only required for an attribute that does in fact implement nested attributes. The `tfsdk.Attribute` type is updated to support both the `Attribute` and `NestedAttribute` interfaces as it accurately describes the overloaded abstraction. The `NestedAttributes` (plural) interface remains to describe how `tfsdk.Attribute` implements that concepts under its `Attributes` field. The `NestedAttributes` (plural) interface and its implementations will be removed when `tfsdk.Attribute` is removed. Another aspect of these changes is cleaning up the type describing methods, removing the separate `Attribute` type `FrameworkType()` method and `NestedAttributes` type `AttributeType()` method. The upcoming split schemas will implement explicit attribute types which only implement `NestedAttribute` (singular) as appropriate.
bflad
added
breaking-change
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Reference: #132
As part of upcoming effort to split schema functionality into the
datasource,provider, andresourcepackages, there are some internal implementation details which need to be sorted beforehand. Throughout the 0.x versions, schema functionality has been migrated from thetfsdkpackage into theinternal/fwschemapackage, but there is some lingering technical debt of duplicate and confusing methods.This change creates a new
NestedAttribute(singular) interface which extends theAttributeinterface with the methods only required for an attribute that does in fact implement nested attributes. Thetfsdk.Attributetype is updated to support both theAttributeandNestedAttributeinterfaces as it accurately describes the overloaded abstraction. TheNestedAttributes(plural) interface remains to describe howtfsdk.Attributeimplements that concepts under itsAttributesfield. TheNestedAttributes(plural) interface and its implementations will be removed whentfsdk.Attributeis removed.Another aspect of these changes is cleaning up the type describing methods, removing the separate
AttributetypeFrameworkType()method andNestedAttributestypeAttributeType()method.The upcoming split schemas will implement explicit attribute types which only implement
NestedAttribute(singular) as appropriate.