PaloAltoNetworks / terraform-provider-sase

Terraform provider for SASE API
Apache License 2.0
1 stars 2 forks source link

Include acceptable parameters within resources. This is one example, but multiple resources need such enhancements to the docs. #7

Closed ancoleman closed 1 year ago

ancoleman commented 1 year ago

Documentation link

https://github.com/PaloAltoNetworks/terraform-provider-sase/blob/main/docs/resources/ike_crypto_profiles.md#required

Describe the problem

Docs are missing acceptable parameters, only includes types. The example link provided was just one such resource where acceptable parameters is missing.

Suggested fix

Example acceptable parameters for ike_crypto_profiles:

shinmog commented 1 year ago

It should be, but isn't... I just updated all docs to also include MarkdownDescription just in case that was needed to include the validator docstrings, but it still isn't being added... So I suspect that this is a bug with the HashiCorp docs generation tool. I've reached out to my contact there to get an answer.