terraform-google-network icon indicating copy to clipboard operation
terraform-google-network copied to clipboard

Properties are not documented well

Open j-windsor opened this issue 2 years ago • 1 comments

Several properties on this module are not documented well. Here are some examples:

  • firewall_rules: The description is simply “List of firewall rules”, the type is any, and the default is an empty array. I can roughly infer this is a list of something (from the default value), but that is all I know. At least provide me with the shape of the object so I can make good guesses.
  • subnets and routes: No evidence other than the sample usage, but I’m pretty sure the type of list(map(string)) is wrong. It seems to be some list of objects of some unknown shape.

Please improve documentation so users don't have to fish through the implementation to determine how to set properties.

j-windsor avatar Sep 28 '22 16:09 j-windsor

Hi @j-windsor I have created a PR for managing this https://github.com/terraform-google-modules/terraform-google-network/pull/384

yuryninog avatar Oct 10 '22 23:10 yuryninog

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 7 days

github-actions[bot] avatar Dec 10 '22 23:12 github-actions[bot]