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

CLOUDP-303335: Remove AtlasCLI docs link from docs for auto-generated commands #3707

Merged
merged 4 commits into from
Mar 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Access logs contain a list of authentication requests made against your cluster.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByClusterName.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-accessTracking-listAccessLogsByClusterName/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Access logs contain a list of authentication requests made against your clusters

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByHostname.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-accessTracking-listAccessLogsByHostname/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This resource remains under revision and may change.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/createAlertConfiguration.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alertConfigurations-createAlertConfiguration/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This resource remains under revision and may change.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/deleteAlertConfiguration.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alertConfigurations-deleteAlertConfiguration/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This resource remains under revision and may change.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/getAlertConfiguration.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alertConfigurations-getAlertConfiguration/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ You can successfully call this endpoint with any assigned role.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationMatchersFieldNames.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This resource remains under revision and may change.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurations.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alertConfigurations-listAlertConfigurations/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This resource remains under revision and may change.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationsByAlertId.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ This resource remains under revision and may change.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/toggleAlertConfiguration.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alertConfigurations-toggleAlertConfiguration/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ This resource remains under revision and may change.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/updateAlertConfiguration.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alertConfigurations-updateAlertConfiguration/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-alerts-acknowledgeAlert.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This resource remains under revision and may change.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/acknowledgeAlert.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alerts-acknowledgeAlert/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-alerts-getAlert.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This resource remains under revision and may change.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/getAlert.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alerts-getAlert/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-alerts-listAlerts.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This resource remains under revision and may change.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlerts.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alerts-listAlerts/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This resource remains under revision and may change.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlertsByAlertConfigurationId.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-alerts-listAlertsByAlertConfigurationId/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ atlas api atlasSearch createAtlasSearchDeployment

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchDeployment.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-createAtlasSearchDeployment/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Atlas Search indexes define the fields on which to create the index and the anal

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndex.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-createAtlasSearchIndex/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Atlas Search indexes define the fields on which to create the index and the anal

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndexDeprecated.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ atlas api atlasSearch deleteAtlasSearchDeployment

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchDeployment.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ To use this resource, the requesting API key must have the Project Data Access A

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndex.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-deleteAtlasSearchIndex/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ To use this resource, the requesting API key must have the Project Data Access A

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndexByName.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ To use this resource, the requesting API Key must have the Project Data Access A

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndexDeprecated.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ atlas api atlasSearch getAtlasSearchDeployment

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchDeployment.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-getAtlasSearchDeployment/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Atlas Search index contains the indexed fields and the analyzers used to create

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndex.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-getAtlasSearchIndex/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Atlas Search index contains the indexed fields and the analyzers used to create

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndexByName.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-getAtlasSearchIndexByName/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ You identify this index using its unique ID. Atlas Search index contains the ind

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndexDeprecated.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Atlas Search indexes contain the indexed fields and the analyzers used to create

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexes.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-listAtlasSearchIndexes/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Atlas Search indexes contain the indexed fields and the analyzers used to create

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexesCluster.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Atlas Search indexes contain the indexed fields and the analyzers used to create

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexesDeprecated.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ atlas api atlasSearch updateAtlasSearchDeployment

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchDeployment.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-updateAtlasSearchDeployment/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Atlas Search indexes define the fields on which to create the index and the anal

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndex.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-updateAtlasSearchIndex/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Atlas Search indexes define the fields on which to create the index and the anal

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexByName.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Atlas Search indexes define the fields on which to create the index and the anal

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexDeprecated.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The auditing configuration defines the events that MongoDB Cloud records in the

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/getAuditingConfiguration.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-auditing-getAuditingConfiguration/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The auditing configuration defines the events that MongoDB Cloud records in the

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/updateAuditingConfiguration.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-auditing-updateAuditingConfiguration/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ To use this resource, the requesting API Key must have the Project Read Only rol

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/getAwsCustomDns.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-awsClustersDns-getAwsCustomDns/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Enable custom DNS if you use AWS VPC peering and use your own DNS servers. To us

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/toggleAwsCustomDns.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-awsClustersDns-toggleAwsCustomDns/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ To use this resource, the requesting API Key must have the Project Backup Manage

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/cancelBackupRestoreJob.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-cloudBackups-cancelBackupRestoreJob/
For more information and examples, see the referenced API documentation linked above.

Syntax
------
Expand Down
Loading