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

fix(synthetics): duplication of default info #2772

Closed
wants to merge 1 commit into from

Conversation

alexis974
Copy link
Contributor

This will remove duplicated default information for [elementsoperator]

@alexis974 alexis974 requested review from a team as code owners January 16, 2025 09:27
Copy link

@aliciascott aliciascott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:) looks good, good catch

@alexis974
Copy link
Contributor Author

Hello,

Is there a maintainer available to trigger the workflow ?

@skarimo
Copy link
Member

skarimo commented Jan 27, 2025

@alexis974 thanks for the PR. The description also needs to be removed from the schema as well: https://github.com/DataDog/terraform-provider-datadog/blob/master/datadog/resource_datadog_synthetics_test_.go#L541
Otherwise docs will be overriden on the next regeneration. We use tfplugindocs for generating docs which is the reason for duplicate being inserted.

@alexis974
Copy link
Contributor Author

alexis974 commented Jan 27, 2025

Hi @skarimo ,
Thanks for your answer. However, I don't see the duplicate info in the schema....
The field Defaults to "firstElementMatches". is already only present once (it is the goal of this PR).
Any idea on why it is present once in the schema, but twice in the doc ?

@skarimo
Copy link
Member

skarimo commented Jan 27, 2025

@alexis974 The terraform docs are autogenerated and the default value gets automatically injected based on the attributes default value during generation. It combines the description and adds a string for default value hence the reason for original duplication. I cherry-picked your commit into #2803 . Closing this PR in favor of above. Thanks!

@skarimo skarimo closed this Jan 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants