Skip to content

Commit

Permalink
Removes atlasCLI docs link from docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cveticm committed Mar 4, 2025
1 parent 316d6d7 commit 7c2bc02
Show file tree
Hide file tree
Showing 507 changed files with 592 additions and 454 deletions.
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
1 change: 1 addition & 0 deletions docs/command/atlas-api-accessTracking.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ atlas api accessTracking
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns access logs for authentication attempts made to Atlas database deployments.

To view database access history, you must have either the Project Owner or Organization Owner role.
For more information and examples, see the referenced API documentation linked above.

Options
-------
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
1 change: 1 addition & 0 deletions docs/command/atlas-api-alertConfigurations.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ atlas api alertConfigurations
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users.

This collection remains under revision and may change.
For more information and examples, see the referenced API documentation linked above.

Options
-------
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
1 change: 1 addition & 0 deletions docs/command/atlas-api-alerts.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ atlas api alerts
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define.

This collection remains under revision and may change.
For more information and examples, see the referenced API documentation linked above.

Options
-------
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
2 changes: 1 addition & 1 deletion docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt
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
1 change: 1 addition & 0 deletions docs/command/atlas-api-atlasSearch.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ atlas api atlasSearch
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns, adds, edits, and removes Atlas Search indexes for the specified cluster.

Also returns and updates user-defined analyzers for the specified cluster.
For more information and examples, see the referenced API documentation linked above.

Options
-------
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
3 changes: 3 additions & 0 deletions docs/command/atlas-api-auditing.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ atlas api auditing

`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns and edits database auditing settings for MongoDB Cloud projects.


For more information and examples, see the referenced API documentation linked above.

Options
-------

Expand Down
Loading

0 comments on commit 7c2bc02

Please sign in to comment.