Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation] arg::timezone does not work as correct on documentation on TF Google 4.42.0, 4.42.1, 4.43+ #12975

Closed
Assignees
Labels

Comments

@IchiruTake
Copy link

According to the test applied on this file [1], the arg::time_zone belongs to the block settings but not setting.sql_server_audit_config block. The misleading placement are found under the documentation from Terraform Google 4.42.0, 4.42.1, and 4.43. I expected this misplacement may come from the portal of Cloud SQL::Create_Instance.
I have re-check the creation and the testing (followed by the .go file) worked.
=> Request to correct the argument's name form

timezone - (Optional) The timezone to be used by the database engine (supported only for SQL Server), in SQL Server timezone format.

to be

time_zone - (Optional) The time zone to be used by the database engine (supported only for SQL Server), in SQL Server time zone format.

Reference:
https://github.com/modular-magician/terraform-provider-google/blob/acb21ee0d5bff50cf94c9b7c63856348a2a1b22c/google/resource_sql_database_instance_test.go

@IchiruTake IchiruTake added the bug label Nov 8, 2022
@IchiruTake IchiruTake changed the title [Documentation] arg::timezone does not work as correct on documentation [Documentation] arg::timezone does not work as correct on documentation on TF Google 4.42.0, 4.42.1, 4.43+ Nov 8, 2022
@edwardmedia edwardmedia self-assigned this Nov 8, 2022
@IchiruTake
Copy link
Author

IchiruTake commented Nov 9, 2022

@edwardmedia According to the difference between the documentation and the test, not only the argument's name is incorrect, but also the argument position as well, which is supposed to be in the settings block not the settings.sql_server_audit_config.

But according to the GCP portal, this field is set when creating SQL Server only. This should be fixed as deep inside the source code, this argument is misplaced.

@IchiruTake
Copy link
Author

@edwardmedia I think the PR is not correct as well. Following the .go file above (line 1569), it shown that the argument :arg:time_zone is located directly in the settings sub-block, not in the settings.sql_server_audit_config. The two or three PRs above just changed the argument's name. It should migrate this argument (in the documentation) into the settings sub-block.

Expected documentation:

`settings` sub-block supported thee arguments
    :arg:`time_zone`: (Optional) ...

`settings.sql_server_audit_config` sub-block supported thee arguments
    ......

Not

`settings` sub-block supported thee arguments
    ....
`settings.sql_server_audit_config` sub-block supported thee arguments
    :arg:`time_zone`: (Optional) ...

@github-actions
Copy link

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 12, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.