terraform-provider-databricks icon indicating copy to clipboard operation
terraform-provider-databricks copied to clipboard

[DOC] Incorrect or misleading document

Open bloomingdave opened this issue 1 year ago • 0 comments

Affected Resource(s)

The databricks_job resource doc confused me, and caused a good bit of trial and error to sort, the health configuration block.

https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/job#health-configuration-block

This text in particular:

This block describes health conditions for a given job or an individual task. It consists of the following attributes:

[rules] - (List) list of rules that are represented as objects with the following attributes:

This suggested to me an argument for "rules" but it needs to be a block.

Also, in getting to the point where I got the argument required error, the init failed with an error saying it expected a comma for new lines between the attributes in the rules list. This didn't help as it never indicated that rules should be a block, it just caused me to rearrange the list to where it had no key values, just values, which allowed the init to pass. It would not pass a validate though, apply and validate had the argument vs block error.

Expected Details

To me "rules - is list of attributes" described under/inside a block meant:

health { list = [] }

If I'm just off base please disregard, tho the error on init would be well served to be improved.

List of things to potentially add/remove

This is a list of things to manipulate in the docs:

  • [ ] "rules is a block"

Important Factoids

References

bloomingdave avatar Sep 05 '24 18:09 bloomingdave