search

hashicorp / terraform-plugin-docs

Generate and validate Terraform plugin/provider documentation.
Mozilla Public License 2.0
221 stars 69 forks source link

Consider Tuple support for doc generator #334

Open austinvalle opened 7 months ago

austinvalle commented 7 months ago

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 https://github.com/hashicorp/terraform-plugin-go/issues/267#issuecomment-1494874479 and a TODO in an error message here: https://github.com/hashicorp/terraform-plugin-docs/blob/6b686eefb31bc0d7e4e7a3a71952e98e882babef/schemamd/render.go#L86

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

bflad commented 7 months ago

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. 👍