-
Notifications
You must be signed in to change notification settings - Fork 42
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
clusterType values not listed #1507
Comments
Thank you @brucemackenzie, we will look into why these values are missing. |
Yep, this is a bug in our docs parsing code. Thanks for reporting it. |
I believe this is, if not a duplicate, then at least related to pulumi/pulumi-libvirt#335. |
Update: We can in fact fix this by more strictly parsing potential properties as presenting in #1969 will not address situations such as pulumi/pulumi-libvirt#335, since in that case we're seeing only lowercase values. |
This pull request asserts that [according to Terraform best practices](https://www.terraform-best-practices.com/naming) we should not parse backticked values containing uppercase letters as potential schema properties. While it is a convention to use `snake_case` for TF properties, it is a strong one. The AWS provider [requires it](https://github.com/hashicorp/terraform-provider-aws/blob/main/docs/naming.md), and other providers follow this convention strictly as well. The reason I would like to bring this change is because it allows us to detect documentation sections that are not actually nested property types, but rather lists of possible values, as described in #1507 in pulumi-mongodbatlas. Rather than add an ever-elusive regex for "Possible values include" et al, we can rely with reasonable confidence on the fact that TF properties are in general lowercase. See sample comparison diffs below. A [comparison diff for mongodbatlas](https://github.com/pulumi/pulumi-mongodbatlas/compare/missing-settings?expand=1) shows multiple improvements. There are a few regressions but the main one is for [a resource](https://www.pulumi.com/registry/packages/mongodbatlas/api-docs/getthirdpartyintegrations/) whose upstream doc is so unconventional that our representation of it is already flawed. Overall, we gain a lot more information than we're losing - the cost is that in a couple of places we get a nonsensical appendage of a real TF description. This should be fixed with docs overrides or by opening an upstream PR. A [comparison diff for AWS](https://github.com/pulumi/pulumi-aws/compare/missing-settings?expand=1) shows even more improvements, with only `V2modelsBotVersionLocaleSpecification` having a single regression, because the upstream docs are erroneously using camelCase. A [comparison diff for GCP](https://github.com/pulumi/pulumi-gcp/compare/missing-settings?expand=1) shows only improvements. A [comparison diff for Azure](https://github.com/pulumi/pulumi-azure/compare/missing-descriptions?expand=1) shows only improvements. **Note** I refactored the tests slightly because I wanted to be able to run individual tests and leave hints as to what they were testing. Fixes #1507.
File: themes/default/content/registry/packages/mongodbatlas/api-docs/cluster/_index.md
Looking in the src code I found these values possible for
clusterType
:REPLICASET
,GEOSHARDED
,SHARDED
The text was updated successfully, but these errors were encountered: