Draft
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Terraform provider documentation to resolve mismatches between documented attributes/arguments and the actual provider schemas, largely by switching to tfplugindocs-generated schema sections.
Changes:
- Replaces many hand-written “Argument/Attributes Reference” sections with
tfplugindocs-generated## Schemablocks. - Aligns documented field names and nested structures with provider schema naming (notably snake_case) and removes outdated/incorrect entries.
- Adds/adjusts a few missing documented fields and clarifies read-only vs configurable attributes via schema output.
Reviewed changes
Copilot reviewed 68 out of 68 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/resources/third_party_integration.md | Replaces manual argument/attribute docs with generated schema for the resource. |
| docs/resources/stream_instance.md | Adds missing documentation entry for max_tier_size. |
| docs/resources/stream_connection.md | Replaces manual argument docs with generated schema (incl. nested schemas/timeouts). |
| docs/resources/serverless_instance.md | Replaces manual argument/attribute docs with generated schema (incl. nested blocks). |
| docs/resources/search_index.md | Adjusts analyzer/tokenizer-related docs formatting/content in the analyzers section. |
| docs/resources/project_api_key.md | Replaces manual argument/attribute docs with generated schema (incl. nested project_assignment). |
| docs/resources/project.md | Replaces manual argument/attribute docs with generated schema (incl. nested limits/teams/ip_addresses). |
| docs/resources/privatelink_endpoint_service.md | Replaces manual argument/attribute docs with generated schema (incl. nested endpoints/timeouts). |
| docs/resources/privatelink_endpoint.md | Replaces manual argument/attribute docs with generated schema (incl. timeouts). |
| docs/resources/network_peering.md | Replaces manual argument/attribute docs with generated schema (incl. timeouts). |
| docs/resources/federated_settings_identity_provider.md | Replaces manual argument/attribute docs with generated schema. |
| docs/resources/federated_query_limit.md | Updates documented enum/value/attribute names to match schema naming. |
| docs/resources/federated_database_instance.md | Fixes documented attribute names to snake_case (e.g., store_name, max_staleness_seconds, atlas_app_id). |
| docs/resources/event_trigger.md | Adds missing exported attribute docs (config_full_document_before, config_schedule_type). |
| docs/resources/database_user.md | Replaces manual argument/attribute docs with generated schema (incl. nested labels/roles/scopes). |
| docs/resources/custom_db_role.md | Replaces manual argument/attribute docs with generated schema (incl. nested actions/resources/inherited_roles). |
| docs/resources/cluster.md | Replaces extensive manual docs section with generated schema (incl. many nested schemas/read-only attrs). |
| docs/resources/cloud_backup_snapshot_restore_job.md | Replaces manual argument/attribute docs with generated schema (incl. nested delivery config). |
| docs/resources/cloud_backup_snapshot_export_job.md | Updates attribute docs structure (export status fields and enum formatting). |
| docs/resources/api_key.md | Replaces manual argument/attribute docs with generated schema (incl. sensitive key fields). |
| docs/resources/alert_configuration.md | Replaces manual argument/attribute docs with generated schema (incl. nested matcher/threshold/notification). |
| docs/data-sources/x509_authentication_database_user.md | Updates documented attributes to match data source schema (customer_x509_cas, certificates). |
| docs/data-sources/third_party_integrations.md | Removes an outdated Microsoft Teams attribute entry. |
| docs/data-sources/third_party_integration.md | Replaces manual argument/attribute docs with generated schema. |
| docs/data-sources/serverless_instances.md | Fixes attribute name to create_date. |
| docs/data-sources/serverless_instance.md | Replaces manual argument/attribute docs with generated schema (incl. nested links/tags). |
| docs/data-sources/search_indexes.md | Renames documented argument to database and adds new returned fields (type, fields). |
| docs/data-sources/search_index.md | Replaces manual argument/attribute docs with generated schema (incl. nested synonyms/type_sets). |
| docs/data-sources/projects.md | Renames user fields to snake_case and adds invitation-related fields. |
| docs/data-sources/project_api_key.md | Replaces manual argument/attribute docs with generated schema (incl. nested project_assignment). |
| docs/data-sources/project.md | Renames user fields to snake_case and adds invitation-related fields. |
| docs/data-sources/organizations.md | Replaces manual argument/attribute docs with generated schema (incl. nested results/users/roles). |
| docs/data-sources/organization.md | Replaces manual argument/attribute docs with generated schema (incl. nested links/users/roles). |
| docs/data-sources/online_archives.md | Renames the data source header to plural and adds total_count. |
| docs/data-sources/network_peering.md | Replaces manual argument/attribute docs with generated schema. |
| docs/data-sources/ldap_verify.md | Removes attributes that shouldn’t be listed as exported for this data source. |
| docs/data-sources/federated_settings_org_role_mappings.md | Removes outdated totalCount mention. |
| docs/data-sources/federated_settings_org_role_mapping.md | Replaces manual argument/attribute docs with generated schema (incl. nested role_assignments). |
| docs/data-sources/federated_settings_org_configs.md | Removes outdated totalCount mention. |
| docs/data-sources/federated_settings_org_config.md | Replaces manual argument/attribute docs with generated schema (incl. nested role_mappings/user_conflicts). |
| docs/data-sources/federated_settings_identity_providers.md | Simplifies example and removes outdated totalCount mention. |
| docs/data-sources/federated_settings_identity_provider.md | Replaces manual argument/attribute docs with generated schema (incl. nested associated_orgs/pem_file_info). |
| docs/data-sources/federated_settings.md | Replaces manual argument/attribute docs with generated schema. |
| docs/data-sources/federated_query_limits.md | Renames returned fields to snake_case and adds overrun_policy/value. |
| docs/data-sources/federated_query_limit.md | Renames returned fields to snake_case and adds overrun_policy/value. |
| docs/data-sources/federated_database_instances.md | Fixes documented attribute names to snake_case. |
| docs/data-sources/federated_database_instance.md | Replaces large manual attribute listing with generated schema (many nested objects). |
| docs/data-sources/event_triggers.md | Adds missing returned fields (trigger_id, schedule/full-document-before fields). |
| docs/data-sources/event_trigger.md | Removes duplicate function_id and adds missing returned fields (schedule/full-document-before). |
| docs/data-sources/database_users.md | Corrects role field name to role_name. |
| docs/data-sources/database_user.md | Replaces manual argument/attribute docs with generated schema (incl. nested labels/roles/scopes). |
| docs/data-sources/custom_db_role.md | Replaces manual argument/attribute docs with generated schema (incl. nested actions/inherited_roles). |
| docs/data-sources/clusters.md | Removes outdated cloud_backup bullet from exported attributes list. |
| docs/data-sources/cluster.md | Replaces extensive manual attribute listing with generated schema (many nested objects). |
| docs/data-sources/cloud_provider_shared_tier_snapshots.md | Renames totalCount to total_count. |
| docs/data-sources/cloud_provider_shared_tier_restore_jobs.md | Renames totalCount to total_count. |
| docs/data-sources/cloud_provider_access_setup.md | Replaces manual argument/attribute docs with generated schema (incl. nested aws/azure/gcp configs). |
| docs/data-sources/cloud_backup_snapshots.md | Renames group_id to project_id and totalCount to total_count in docs. |
| docs/data-sources/cloud_backup_snapshot_restore_jobs.md | Renames totalCount to total_count and normalizes oplog/time fields to snake_case. |
| docs/data-sources/cloud_backup_snapshot_restore_job.md | Normalizes oplog/time fields to snake_case and removes an outdated attribute entry. |
| docs/data-sources/cloud_backup_snapshot_export_jobs.md | Renames totalCount to total_count and restructures export status fields in docs. |
| docs/data-sources/cloud_backup_snapshot_export_job.md | Restructures export status fields in docs and normalizes enum formatting. |
| docs/data-sources/cloud_backup_snapshot_export_buckets.md | Renames totalCount to total_count. |
| docs/data-sources/backup_compliance_policy.md | Removes an outdated attribute entry from the exported list. |
| docs/data-sources/alert_configurations.md | Renames notifications to notification to match schema naming. |
| docs/data-sources/alert_configuration.md | Renames notifications to notification and removes outdated output field docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
79
to
82
| In addition to all arguments above, the following attributes are exported: | ||
|
|
||
| * `current_certificate` - Contains the last X.509 certificate and private key created for a database user. | ||
| * `customer_x509_cas` - Contains the last X.509 certificate and private key created for a database user. | ||
|
|
There was a problem hiding this comment.
customer_x509_cas is the customer-managed CA bundle (per the provider schema), but the description says it "contains the last X.509 certificate and private key". That wording matches current_certificate from the resource and is misleading for this data source. Please update this description to reflect that it returns the PEM string for the configured customer X.509 CAs (and that it is sensitive).
Comment on lines
252
to
258
| * `name` - (Required) | ||
| Name of the custom analyzer. Names must be unique within an index, and may **not** start with any of the following strings: | ||
| * `lucene` | ||
| * `builtin` | ||
| * `mongodb` | ||
| * `charFilters` - Array containing zero or more character filters. Always require a `type` field, and some take additional options as well | ||
| * "lucene" | ||
| * "builtin" | ||
| * "mongodb" | ||
| * "charFilters" - Array containing zero or more character filters. Always require a `type` field, and some take additional options as well | ||
| ```terraform |
There was a problem hiding this comment.
This section mixes backtick-formatted field names (e.g., name) with double-quoted names (e.g., "charFilters", "tokenizer", "ignoredTags"). The quoted form is inconsistent with the rest of the doc and reads like JSON rather than an argument/attribute name list. Consider reverting these to backticks (and keep a single style throughout) to avoid confusing readers about what is literal JSON vs documentation formatting.
Comment on lines
387
to
388
| If `matches` is set to `all, replace all matching patterns. Otherwise, replace only the first matching pattern. | ||
| * [snowballStemming](https://docs.atlas.mongodb.com/reference/atlas-search/analyzers/custom/#std-label-snowballstemming-tf-ref) - Stems tokens using a [Snowball-generated stemmer](https://snowballstem.org/). |
There was a problem hiding this comment.
Inline code formatting is broken here: the backtick for the all value isn't closed (it currently reads If `matches` is set to `all, ...). This renders poorly and is easy to misread. Please close the backticks so the sentence clearly distinguishes the literal value all from the surrounding text.
Comment on lines
+5
to
8
| # Data Source: mongodbatlas_online_archives | ||
|
|
||
| `mongodbatlas_online_archive` Describes the list of all the online archives for a cluster | ||
|
|
There was a problem hiding this comment.
The data source title is mongodbatlas_online_archives, but the short description still references the singular mongodbatlas_online_archive. This is inconsistent and may confuse users searching/copying the data source name. Please update the description line to use mongodbatlas_online_archives (and keep the naming consistent throughout the page).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Fix documentation attribute inconsistencies with resource and data source schemas.
This PR is for illustration purposes only and will not be merged.
Link to any related issue(s): CLOUDP-384244
Type of change:
Required Checklist:
Further comments