hashicorp / hashicorp/terraform-plugin-framework

Lack of `SchemaDescriptionBuilder` equivalent (from sdkv2)

Open
#625 4 comments 0 reactions 0 assignees View on GitHub
enhancement sdkv2-parity
Dominant language
Go
Stars
384
Forks
107
Avg merge
3m
Merged PRs (30d)
1

Description

### Module version

```
github.com/hashicorp/terraform-plugin-framework v1.1.1
```

### Overview

Within [terraform-provider-cloudflare](https://github.com/cloudflare/terraform-provider-cloudflare/), we heavily rely on `terraform-plugin-docs` to generate our documentation. As part of this, we have an `init` method that handles some formatting that we specifically want to all field attributes. I.e. if changing a schema attribute will force a replacement, we call that out in the description.

https://github.com/cloudflare/terraform-provider-cloudflare/blob/20222d155d457736d71eaa41a63bb87853cfaf29/internal/provider/provider.go#L19-L76

From the code snippet, you can see that it relies on `SchemaDescriptionBuilder` and a function that modifies the descriptions to match our format.

I've had a dig around in the framework codebase but I'm unable to find anything that resembles any similar (even in the provider `Configure`). Have I overlooked this? Or is this not supported in its current form?

### References

n/a

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.