hashicorp / hashicorp/terraform-plugin-framework

Documentation: specify if ParameterWith<type>Validators is intended for external usage

Open
#1,079 3 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Go
Stars
384
Forks
107
Avg merge
3m
Merged PRs (30d)
1

Description

At the moment the documentation contains multiple types for the `function` package with names such as `ParameterWithValidators`. These types are also (of course) public. These types contain member fields for `Parameter` type inputs and slices of `ParameterValidator`. At the moment these types all appear to mostly facilitate "get" return functionality for the module, and not really support inputs. However, the definition signatures would appear to be interesting if they could be externally consumed.

Could the Go package documentation for the `ParameterWithValidators` please be updated to specify if these are for module internal usage, or whether they are external facing?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.