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-297209: Add disclaimer to --help and docs #3587

Merged
merged 4 commits into from
Jan 30, 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 @@ -12,7 +12,7 @@ atlas api accessTracking listAccessLogsByClusterName
:depth: 1
:class: singlecol

Returns the access logs of one cluster identified by the cluster's name.
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns the access logs of one cluster identified by the cluster's name.

Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role. This command is invoking the endpoint with OperationID: 'listAccessLogsByClusterName'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByClusterName

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ atlas api accessTracking listAccessLogsByHostname
:depth: 1
:class: singlecol

Returns the access logs of one cluster identified by the cluster's hostname.
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns the access logs of one cluster identified by the cluster's hostname.

Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role. This command is invoking the endpoint with OperationID: 'listAccessLogsByHostname'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByHostname

Expand Down
6 changes: 3 additions & 3 deletions docs/command/atlas-api-accessTracking.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ atlas api accessTracking
:depth: 1
:class: singlecol

Returns access logs for authentication attempts made to Atlas database deployments.
`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.

Expand Down Expand Up @@ -51,8 +51,8 @@ Inherited Options
Related Commands
----------------

* :ref:`atlas-api-accessTracking-listAccessLogsByClusterName` - Returns the access logs of one cluster identified by the cluster's name.
* :ref:`atlas-api-accessTracking-listAccessLogsByHostname` - Returns the access logs of one cluster identified by the cluster's hostname.
* :ref:`atlas-api-accessTracking-listAccessLogsByClusterName` - `experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns the access logs of one cluster identified by the cluster's name.
* :ref:`atlas-api-accessTracking-listAccessLogsByHostname` - `experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns the access logs of one cluster identified by the cluster's hostname.


.. toctree::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ atlas api alertConfigurations createAlertConfiguration
:depth: 1
:class: singlecol

Creates one alert configuration for the specified project.
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Creates one alert configuration for the specified project.

Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'createAlertConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/createAlertConfiguration

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ atlas api alertConfigurations deleteAlertConfiguration
:depth: 1
:class: singlecol

Removes one alert configuration from the specified project.
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Removes one alert configuration from the specified project.

To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'deleteAlertConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/deleteAlertConfiguration

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ atlas api alertConfigurations getAlertConfiguration
:depth: 1
:class: singlecol

Returns the specified alert configuration from the specified project.
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns the specified alert configuration from the specified project.

To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'getAlertConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/getAlertConfiguration

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ atlas api alertConfigurations listAlertConfigurationMatchersFieldNames
:depth: 1
:class: singlecol

Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration.
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration.

You can successfully call this endpoint with any assigned role. This command is invoking the endpoint with OperationID: 'listAlertConfigurationMatchersFieldNames'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationMatchersFieldNames

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ atlas api alertConfigurations listAlertConfigurations
:depth: 1
:class: singlecol

Returns all alert configurations for one project.
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns all alert configurations for one project.

These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'listAlertConfigurations'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurations

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ atlas api alertConfigurations listAlertConfigurationsByAlertId
:depth: 1
:class: singlecol

Returns all alert configurations set for the specified alert.
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns all alert configurations set for the specified alert.

To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'listAlertConfigurationsByAlertId'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationsByAlertId

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ atlas api alertConfigurations toggleAlertConfiguration
:depth: 1
:class: singlecol

Enables or disables the specified alert configuration in the specified project.
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Enables or disables the specified alert configuration in the specified project.

The resource enables the specified alert configuration if currently enabled. The resource disables the specified alert configuration if currently disabled. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. NOTE: This endpoint updates only the enabled/disabled state for the alert configuration. To update more than just this configuration, see Update One Alert Configuration. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'toggleAlertConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/toggleAlertConfiguration

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ atlas api alertConfigurations updateAlertConfiguration
:depth: 1
:class: singlecol

Updates one alert configuration in the specified project.
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Updates one alert configuration in the specified project.

Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. NOTE: To enable or disable the alert configuration, see Toggle One State of One Alert Configuration in One Project. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'updateAlertConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/updateAlertConfiguration

Expand Down
18 changes: 9 additions & 9 deletions docs/command/atlas-api-alertConfigurations.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ atlas api alertConfigurations
:depth: 1
:class: singlecol

Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users.
`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.

Expand Down Expand Up @@ -51,14 +51,14 @@ Inherited Options
Related Commands
----------------

* :ref:`atlas-api-alertConfigurations-createAlertConfiguration` - Creates one alert configuration for the specified project.
* :ref:`atlas-api-alertConfigurations-deleteAlertConfiguration` - Removes one alert configuration from the specified project.
* :ref:`atlas-api-alertConfigurations-getAlertConfiguration` - Returns the specified alert configuration from the specified project.
* :ref:`atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames` - Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration.
* :ref:`atlas-api-alertConfigurations-listAlertConfigurations` - Returns all alert configurations for one project.
* :ref:`atlas-api-alertConfigurations-listAlertConfigurationsByAlertId` - Returns all alert configurations set for the specified alert.
* :ref:`atlas-api-alertConfigurations-toggleAlertConfiguration` - Enables or disables the specified alert configuration in the specified project.
* :ref:`atlas-api-alertConfigurations-updateAlertConfiguration` - Updates one alert configuration in the specified project.
* :ref:`atlas-api-alertConfigurations-createAlertConfiguration` - `experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Creates one alert configuration for the specified project.
* :ref:`atlas-api-alertConfigurations-deleteAlertConfiguration` - `experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Removes one alert configuration from the specified project.
* :ref:`atlas-api-alertConfigurations-getAlertConfiguration` - `experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns the specified alert configuration from the specified project.
* :ref:`atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames` - `experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration.
* :ref:`atlas-api-alertConfigurations-listAlertConfigurations` - `experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns all alert configurations for one project.
* :ref:`atlas-api-alertConfigurations-listAlertConfigurationsByAlertId` - `experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns all alert configurations set for the specified alert.
* :ref:`atlas-api-alertConfigurations-toggleAlertConfiguration` - `experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Enables or disables the specified alert configuration in the specified project.
* :ref:`atlas-api-alertConfigurations-updateAlertConfiguration` - `experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Updates one alert configuration in the specified project.


.. toctree::
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 @@ -12,7 +12,7 @@ atlas api alerts acknowledgeAlert
:depth: 1
:class: singlecol

Confirms receipt of one existing alert.
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Confirms receipt of one existing alert.

This alert applies to any component in one project. Acknowledging an alert prevents successive notifications. You receive an alert when a monitored component meets or exceeds a value you set until you acknowledge the alert. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'acknowledgeAlert'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/acknowledgeAlert

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 @@ -12,7 +12,7 @@ atlas api alerts getAlert
:depth: 1
:class: singlecol

Returns one alert.
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns one alert.

This alert applies to any component in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'getAlert'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/getAlert

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 @@ -12,7 +12,7 @@ atlas api alerts listAlerts
:depth: 1
:class: singlecol

Returns all alerts.
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns all alerts.

These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'listAlerts'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlerts

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ atlas api alerts listAlertsByAlertConfigurationId
:depth: 1
:class: singlecol

Returns all open alerts that the specified alert configuration triggers.
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns all open alerts that the specified alert configuration triggers.

These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'listAlertsByAlertConfigurationId'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlertsByAlertConfigurationId

Expand Down
10 changes: 5 additions & 5 deletions docs/command/atlas-api-alerts.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ atlas api alerts
:depth: 1
:class: singlecol

Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define.
`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.

Expand Down Expand Up @@ -51,10 +51,10 @@ Inherited Options
Related Commands
----------------

* :ref:`atlas-api-alerts-acknowledgeAlert` - Confirms receipt of one existing alert.
* :ref:`atlas-api-alerts-getAlert` - Returns one alert.
* :ref:`atlas-api-alerts-listAlerts` - Returns all alerts.
* :ref:`atlas-api-alerts-listAlertsByAlertConfigurationId` - Returns all open alerts that the specified alert configuration triggers.
* :ref:`atlas-api-alerts-acknowledgeAlert` - `experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Confirms receipt of one existing alert.
* :ref:`atlas-api-alerts-getAlert` - `experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns one alert.
* :ref:`atlas-api-alerts-listAlerts` - `experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns all alerts.
* :ref:`atlas-api-alerts-listAlertsByAlertConfigurationId` - `experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns all open alerts that the specified alert configuration triggers.


.. toctree::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ atlas api atlasSearch createAtlasSearchDeployment
:depth: 1
:class: singlecol

Creates Search Nodes for the specified cluster.
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Creates Search Nodes for the specified cluster.

This command is invoking the endpoint with OperationID: 'createAtlasSearchDeployment'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchDeployment

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ atlas api atlasSearch createAtlasSearchIndex
:depth: 1
:class: singlecol

Creates one Atlas Search index on the specified collection.
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Creates one Atlas Search index on the specified collection.

Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'createAtlasSearchIndex'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndex

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ atlas api atlasSearch createAtlasSearchIndexDeprecated
:depth: 1
:class: singlecol

Creates one Atlas Search index on the specified collection.
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Creates one Atlas Search index on the specified collection.

Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'createAtlasSearchIndexDeprecated'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndexDeprecated

Expand Down
Loading