Question: Is showing a Required field as Optional when setting DefaultFunc the best approach? about terraform-plugin-docs

[fbreckle]

I recently updated my tfplugindocs and now encountered this. I find this behavior confusing as well and I agree with all your points.

[thecodeassassin]

It would be great if it skips marking the schema as Optional when Required is set to true

[fbreckle]

I looked into this and I think this is not something that can be fixed in terraform-plugin-docs. It reads the json schema provided by the plugin and, for example, this code in the provider schema:

"api_token": {
	Type:        schema.TypeString,
	Required:    true,
	DefaultFunc: schema.EnvDefaultFunc("NETBOX_API_TOKEN", nil),
	Description: "Netbox API authentication token. Can be set via the `NETBOX_API_TOKEN` environment variable.",
},

leads to this in the schema (shown with terraform providers schema -json):

"api_token": {
	"type": "string",
	"description": "Netbox API authentication token. Can be set via the `NETBOX_API_TOKEN` environment variable.",
	"description_kind": "markdown",
	"optional": true 
},

Note that we went from Required: true in to "optional": true. So when terraform-plugin-docs does its thing, the damage is already done.