Remove unused AssociatedExternalType and add schema versioning

hashicorp / terraform-plugin-codegen-spec

Terraform Provider Code Generation Specification and Go Bindings

Mozilla Public License 2.0

7 stars 4 forks source link

Remove unused AssociatedExternalType and add schema versioning #47

Closed bendbennett closed 11 months ago

bendbennett commented 11 months ago

This PR

Removes AssociatedExternalType except for list, map, set, and single nested attributes and blocks.
Adds versioning to the schema through the $id field and addition of top-level version field.
Adds Go docs.

The approach for versioning includes a breaking change, in that calls to spec.Parse() and spec.Validate() will now require that schema version that should be used for validation be supplied in those function calls.

bflad commented 11 months ago

I'm 👍 AssocitedExternalType removals for now, but the versioning seems a little awkward to me as a required function parameter for Parse()/Validate when it should already be in the given document contents. Presumably we should be able to have folks upgrade their Go module and able to use the "latest" specification minor version without requiring downstream code changes.

austinvalle commented 11 months ago

LGTM, I'd vote since this is a tech preview to go with 0.1 to indicate it's stable as a preview but not necessarily a compatibility guarantee for the future 👍🏻

bendbennett commented 11 months ago

Have updated to use 0.1 as current version.

github-actions[bot] commented 3 months ago

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. If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.