hashicorp/terraform-plugin-docs

Consider Tuple support for doc generator

austinvalle opened this issue · 1 comments

austinvalle commented

Terraform CLI and terraform-plugin-docs Versions

github.com/hashicorp/terraform-plugin-docs v0.18.0

Use Cases or Problem Statement

Bubbling up from this comment hashicorp/terraform-plugin-go#267 (comment) and a TODO in an error message here:

terraform-plugin-docs/schemamd/render.go

Line 86 in 6b686ee

return nil, fmt.Errorf("TODO: tuples are not yet supported")

Tuple support is currently not implemented in tfplugindocs because neither SDKv2 or Plugin Framework support schema attributes as tuples. Despite this, it's still possible to write a provider that has tuple's in the schema with terraform-plugin-go.

This issue can be used to capture any interest in adding render logic for Tuples in tfplugindocs.

Proposal

TBD

How much impact is this issue causing?

Low

Additional Information

Code of Conduct

  • I agree to follow this project's Code of Conduct
bflad commented

Drive-by comment: The documentation generation might need some special formatting consideration since there can be an arbitrary number of ordered element types for a tuple and usually the type Markdown is something like (List of String) for existing collection types. Also, the protocol only contains type information and nothing like descriptions for each element type, so it would also be interesting to hear if any use cases involve complex tuples that might warrant additional information and formatting (e.g. a sub-list) like objects in #333. 👍

  • 👍1