synthetics_create_browser_check_v2 documentation

[aport1996]

Hello,

For the following documentation (but also the others): https://registry.terraform.io/providers/splunk/synthetics/latest/docs/resources/create_browser_check_v2#nestedblock--test--transactions--steps

We don't see any information on what values we can enter for the various variables that there are.

For example, we don't know what values we can use for keys such as "selector", "selector_type", etc.

Can you please add this to the terraform documentation, or point us to the right documentation if it exists?

Thank you!

[greatestusername-splunk]

Thank you for posting this issue!
Currently the best place to find the acceptable values is from the api documentation.

Due to the terraform provider being an interface for the API the provider isn't really the source of truth for acceptable values. That said, it may be possible to specifically add some of the accepted values and a link to the actual API documentation in the terraform provider docs (keeping in mind they will never be the source of truth).

[kkgthb]

I volunteered #75 to try to help address this issue, because the aforementioned API documentation about accepted type, selector_type, etc. values is actually quite abysmal, and the Terraform provider docs and unit tests have been my only hope at guessing how the API works. (If you have contacts in the API docs team ... poke? 😉.)

Anyway, docs/resources/create_browser_check_v2.md, I:

1. Left all examples of selector_type as id as before, but added an inline comment at the end of the first example listing all 6 valid selector_type values (id, name, xpath, css, link, jspath -- you can find these by trying to use a selector_type of helloworld and running terraform apply).
2. Added 6 new "assertion" step type examples to cover Documentation example code does not mention the existence of any of the 6 "assertion" step types (assert_element_present, assert_element_not_present, assert_element_visible, assert_element_not_visible, assert_text_present, assert_text_not_present -- y'all mentioned these in release v2.0.12 notes).
   • (Though now that I try terraform apply with a step type of helloworld, I see the full list available is accept_alert, assert_element_not_present, assert_element_not_visible, assert_element_present, assert_element_visible, assert_text_not_present, assert_text_present, clear_element, click_element, dismiss_alert, enter_value, go_to_url, run_javascript, select_option, store_variable_from_element, store_variable_from_javascript, switch_to_iframe, switch_to_main, wait -- not sure if I'll circle back to eventually making sure they all have examples.)