doc: Fixes path for collection attributes in cluster docs #3739

maastha · 2025-10-01T18:45:27Z

Description

Addresses this github issue #3334. While our current document does mention below note, I think it can still be confusing and inconsistent with rest of the documentation, so making minor updates to the documentation as per recommendation in the Github issue.

Adding ".#" to an attribute signifies that it is a collection attribute & it's sub-elements can be referenced with an index value such as connection_strings[0].srv.

**NOTE** Connection strings must be returned as a list, therefore to refer to a specific attribute value add index notation.

Link to any related issue(s): CLOUDP-319584

Type of change:

Bug fix (non-breaking change which fixes an issue). Please, add the "bug" label to the PR.
New feature (non-breaking change which adds functionality). Please, add the "enhancement" label to the PR. A migration guide must be created or updated if the new feature will go in a major version.
Breaking change (fix or feature that would cause existing functionality to not work as expected). Please, add the "breaking change" label to the PR. A migration guide must be created or updated.
This change requires a documentation update
Documentation fix/enhancement

Required Checklist:

I have signed the MongoDB CLA
I have read the contributing guides
I have checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
I have added tests that prove my fix is effective or that my feature works per HashiCorp requirements
I have added any necessary documentation (if appropriate)
I have run make fmt and formatted my code
If changes include deprecations or removals I have added appropriate changelog entries.
If changes include removal or addition of 3rd party GitHub actions, I updated our internal document. Reach out to the APIx Integration slack channel to get access to the internal document.

Further comments

maastha · 2025-10-01T18:48:36Z

docs/resources/advanced_cluster.md

 -> **NOTE:** If Backup Compliance Policy is enabled for the project for which this backup schedule is defined, you cannot modify the backup schedule for an individual cluster below the minimum requirements set in the Backup Compliance Policy.  See [Backup Compliance Policy Prohibited Actions and Considerations](https://www.mongodb.com/docs/atlas/backup/cloud-backup/backup-compliance-policy/#configure-a-backup-compliance-policy).

-> **NOTE:** A network container is created for each provider/region combination on the advanced cluster. This can be referenced via a computed attribute for use with other resources. Refer to the `replication_specs[#].container_id` attribute in the [Attributes Reference](#attributes_reference) for more information.
+-> **NOTE:** A network container is created for each provider/region combination on the advanced cluster. This can be referenced via a computed attribute for use with other resources. Refer to the `replication_specs.#.container_id` attribute in the [Attributes Reference](#attributes_reference) for more information.


making doc consistent to use .#. as used in most other docs

github-actions · 2025-10-01T18:54:18Z

APIx bot: a message has been sent to Docs Slack channel

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

manupedrozo · 2025-10-03T14:57:30Z

docs/data-sources/cluster.md

-    - `connection_strings.private_endpoint.#.endpoints.#.endpoint_id` - Unique identifier of the private endpoint.
-    - `connection_strings.private_endpoint.#.endpoints.#.provider_name` - Cloud provider to which you deployed the private endpoint. Atlas returns `AWS` or `AZURE`.
-    - `connection_strings.private_endpoint.#.endpoints.#.region` - Region to which you deployed the private endpoint.
+    - `connection_strings.#.standard` -   Public mongodb:// connection string for this cluster.


Unrelated to your changes: In the docs these currently show up as a code block.
Maybe an extra space before this line would fix it. Not sure as it renders fine in github, its a registry issue only.

nice catch! was an indentation issue with the code block. Fixed!

* master: doc: Fixes path for collection attributes in cluster docs (#3739) build(deps): bump go.mongodb.org/atlas-sdk (#3750) # Conflicts: # internal/service/projectapikey/model_project_api_key.go

* master: chore: Allow SA for mongodbatlas_roles_org_id datasource (#3764) doc: Fixes path for collection attributes in cluster docs (#3739) build(deps): bump go.mongodb.org/atlas-sdk (#3750) doc: Add FLEX value under provider_name in advanced_cluster docs (#3763) chore: Add codegen intermediate model serialization (#3756) chore: Bump github.com/hashicorp/terraform-plugin-framework-validators (#3761) chore: Bump softprops/action-gh-release from 2.3.3 to 2.4.0 (#3759) chore: Bump actions/stale from 10.0.0 to 10.1.0 (#3758) chore: Bump peter-evans/create-or-update-comment from 4.0.0 to 5.0.0 (#3760) chore: Bump github.com/hashicorp/terraform-plugin-framework (#3762) include acceptance tests for org service account resource (#3755) chore: Add project_settings_api acceptance tests (#3751) chore: Add create only plan modifier for non-updateable attributes in autogenerated resources (#3747) # Conflicts: # go.mod # internal/service/advancedcluster/common.go # internal/service/advancedcluster/common_model_sdk_version_conversion.go # internal/service/advancedcluster/common_model_sdk_version_conversion_test.go # internal/service/advancedcluster/resource_test.go

maastha added 2 commits October 1, 2025 20:36

fix connection_str format

f3e749b

adv cluster docs

e65f79e

maastha commented Oct 1, 2025

View reviewed changes

nit

1f14c4f

maastha marked this pull request as ready for review October 1, 2025 18:53

maastha requested a review from a team as a code owner October 1, 2025 18:53

Copilot AI review requested due to automatic review settings October 1, 2025 18:53

Copilot AI reviewed Oct 1, 2025

View reviewed changes

maastha requested a review from Copilot October 2, 2025 13:25

Copilot AI reviewed Oct 2, 2025

View reviewed changes

manupedrozo approved these changes Oct 3, 2025

View reviewed changes

jvincent-mongodb approved these changes Oct 3, 2025

View reviewed changes

Update cluster.md

f3e15c1

maastha merged commit bb93f96 into master Oct 8, 2025
45 checks passed

maastha deleted the CLOUDP-319584 branch October 8, 2025 16:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

doc: Fixes path for collection attributes in cluster docs #3739

doc: Fixes path for collection attributes in cluster docs #3739

Uh oh!

maastha commented Oct 1, 2025 •

edited

Loading

Uh oh!

maastha Oct 1, 2025

Uh oh!

github-actions bot commented Oct 1, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

manupedrozo Oct 3, 2025

Uh oh!

maastha Oct 8, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

doc: Fixes path for collection attributes in cluster docs #3739

doc: Fixes path for collection attributes in cluster docs #3739

Uh oh!

Conversation

maastha commented Oct 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change:

Required Checklist:

Further comments

Uh oh!

maastha Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Oct 1, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

manupedrozo Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

maastha Oct 8, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

maastha commented Oct 1, 2025 •

edited

Loading