Terraform CLI and terraform-plugin-docs Versions

latest

Use Cases or Problem Statement

It would be nice for users to know more about a parameters behaviors without having to write lengthy custom descriptions. It would also be nice to be able to have a unified look to documentation so common questions are answered uniformly and generated instead of hand typed.

Specifically it would be nice to know a parameters:

• default value - if applicable
• updateability - if it can be updated or requires replacement
• validators - what types of validations are run against the input

Proposal

Technical implementation is currently limited by missing fields in the schema. That aside, here are some proposals for how to display the information:

- `my_parameter`: <description>
  - Type: <type>  
  - Default: "one"
  - Plan Modifiers: 
    - Forces Recreation
  - Validators:
    - Any one of: `one`, `two`, `three`

How much impact is this issue causing?

Low

Additional Information

No response

Code of Conduct

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