Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add validator docstrings to params for providers using terraform-plugin-framework #243

Open
shinmog opened this issue Apr 10, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@shinmog
Copy link

shinmog commented Apr 10, 2023

I'm pretty sure that terraform-plugin-docs adds the validator docstrings to a param's docstring when the provider is built using SDKv2, but this is not happening for my provider built using terraform-plugin-framework. I would like it if terraform-plugin-docs would add in the validator docstrings to params when the provider is using terraform-plugin-framework, as all of the docstrings are already present on terraform-plugin-framework-validators.

@austinvalle
Copy link
Member

Hi there @shinmog 👋🏻 , thanks for submitting this issue!

This is related to both #156 and hashicorp/terraform-plugin-framework#625 (comment), in that it has the similar constraint of the current design of terraform-plugin-docs. We don't currently have a clear path for solving this issue yet and I'll try to give more context as to why.

The current terraform-plugin-docs tool is dependent on using Terraform CLI's terraform providers schema -json output. This dependency restricts us in what we can easily change to provide richer documentation for providers today (such as the validator descriptions), as we can only utilize Description and MarkdownDescrption of the Resources/DataSources/Providers. To reference another similar request that has a more detailed answer here, our next step is to move away from this dependency by providing richer schema information directly from the provider itself (that format/process is still TBD, but the implementation would be in the new terraform-plugin-framework).

Apologies that this might not be the answer you're looking for, but hopefully it gives you useful context into how we're planning on approaching the problem.

@austinvalle austinvalle added the enhancement New feature or request label Apr 10, 2023
martinohansen added a commit to mezmo/terraform-provider-mezmo that referenced this issue May 13, 2024
Add possible values to mezmo_filter_processor and operator attribute
until hashicorp/terraform-plugin-docs#243 is
fixed. This tells the user which values are accepted in the docs.

Ref: LOG-19859
gjanco pushed a commit to mezmo/terraform-provider-mezmo that referenced this issue May 13, 2024
* doc: add possible values

Add possible values to mezmo_filter_processor and operator attribute
until hashicorp/terraform-plugin-docs#243 is
fixed. This tells the user which values are accepted in the docs.

Ref: LOG-19859

* ci: fix CODEOWNERS file

Group is private and not accessible.

Ref: INFRA-7098
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants