Skip to content

Commit 034d05b

Browse files
authored
CLOUDP-307055 Mark autogen'd L1 commands as being in Public Preview (#3755)
1 parent 4c36ccf commit 034d05b

File tree

508 files changed

+1015
-1012
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

508 files changed

+1015
-1012
lines changed

.github/labeler.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ labels:
88
type: "pull_request"
99
draft: False
1010
files:
11-
- "docs/command/*.txt"
11+
- "docs\\/command\\/.*\\.txt"
1212
- label: "mongocli"
1313
type: "pull_request"
1414
draft: False

docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ atlas api accessTracking listAccessLogsByClusterName
1212
:depth: 1
1313
:class: singlecol
1414

15-
`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.
15+
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the access logs of one cluster identified by the cluster's name.
1616

1717
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 or the Project Database Access Admin role.
1818

docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ atlas api accessTracking listAccessLogsByHostname
1212
:depth: 1
1313
:class: singlecol
1414

15-
`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.
15+
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the access logs of one cluster identified by the cluster's hostname.
1616

1717
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 or the Project Database Access Admin role.
1818

docs/command/atlas-api-accessTracking.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ atlas api accessTracking
1212
:depth: 1
1313
:class: singlecol
1414

15-
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns access logs for authentication attempts made to Atlas database deployments.
15+
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns access logs for authentication attempts made to Atlas database deployments.
1616

1717
To view database access history, you must have either the Project Owner or Organization Owner role.
1818

@@ -51,8 +51,8 @@ Inherited Options
5151
Related Commands
5252
----------------
5353

54-
* :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.
55-
* :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.
54+
* :ref:`atlas-api-accessTracking-listAccessLogsByClusterName` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the access logs of one cluster identified by the cluster's name.
55+
* :ref:`atlas-api-accessTracking-listAccessLogsByHostname` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the access logs of one cluster identified by the cluster's hostname.
5656

5757

5858
.. toctree::

docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ atlas api alertConfigurations createAlertConfiguration
1212
:depth: 1
1313
:class: singlecol
1414

15-
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Creates one alert configuration for the specified project.
15+
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Creates one alert configuration for the specified project.
1616

1717
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.
1818

docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ atlas api alertConfigurations deleteAlertConfiguration
1212
:depth: 1
1313
:class: singlecol
1414

15-
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Removes one alert configuration from the specified project.
15+
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Removes one alert configuration from the specified project.
1616

1717
To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.
1818

docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ atlas api alertConfigurations getAlertConfiguration
1212
:depth: 1
1313
:class: singlecol
1414

15-
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns the specified alert configuration from the specified project.
15+
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the specified alert configuration from the specified project.
1616

1717
To use this resource, the requesting API Key must have the Project Read Only role.
1818

docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ atlas api alertConfigurations listAlertConfigurationMatchersFieldNames
1212
:depth: 1
1313
:class: singlecol
1414

15-
`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.
15+
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration.
1616

1717
You can successfully call this endpoint with any assigned role.
1818

docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ atlas api alertConfigurations listAlertConfigurations
1212
:depth: 1
1313
:class: singlecol
1414

15-
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns all alert configurations for one project.
15+
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all alert configurations for one project.
1616

1717
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.
1818

docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ atlas api alertConfigurations listAlertConfigurationsByAlertId
1212
:depth: 1
1313
:class: singlecol
1414

15-
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns all alert configurations set for the specified alert.
15+
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all alert configurations set for the specified alert.
1616

1717
To use this resource, the requesting API Key must have the Project Read Only role.
1818

docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ atlas api alertConfigurations toggleAlertConfiguration
1212
:depth: 1
1313
:class: singlecol
1414

15-
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Enables or disables the specified alert configuration in the specified project.
15+
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Enables or disables the specified alert configuration in the specified project.
1616

1717
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.
1818

docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ atlas api alertConfigurations updateAlertConfiguration
1212
:depth: 1
1313
:class: singlecol
1414

15-
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Updates one alert configuration in the specified project.
15+
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Updates one alert configuration in the specified project.
1616

1717
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.
1818

docs/command/atlas-api-alertConfigurations.txt

+9-9
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ atlas api alertConfigurations
1212
:depth: 1
1313
:class: singlecol
1414

15-
`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.
15+
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users.
1616

1717
This collection remains under revision and may change.
1818

@@ -51,14 +51,14 @@ Inherited Options
5151
Related Commands
5252
----------------
5353

54-
* :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.
55-
* :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.
56-
* :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.
57-
* :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.
58-
* :ref:`atlas-api-alertConfigurations-listAlertConfigurations` - `experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns all alert configurations for one project.
59-
* :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.
60-
* :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.
61-
* :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.
54+
* :ref:`atlas-api-alertConfigurations-createAlertConfiguration` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Creates one alert configuration for the specified project.
55+
* :ref:`atlas-api-alertConfigurations-deleteAlertConfiguration` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Removes one alert configuration from the specified project.
56+
* :ref:`atlas-api-alertConfigurations-getAlertConfiguration` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the specified alert configuration from the specified project.
57+
* :ref:`atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration.
58+
* :ref:`atlas-api-alertConfigurations-listAlertConfigurations` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all alert configurations for one project.
59+
* :ref:`atlas-api-alertConfigurations-listAlertConfigurationsByAlertId` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all alert configurations set for the specified alert.
60+
* :ref:`atlas-api-alertConfigurations-toggleAlertConfiguration` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Enables or disables the specified alert configuration in the specified project.
61+
* :ref:`atlas-api-alertConfigurations-updateAlertConfiguration` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Updates one alert configuration in the specified project.
6262

6363

6464
.. toctree::

docs/command/atlas-api-alerts-acknowledgeAlert.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ atlas api alerts acknowledgeAlert
1212
:depth: 1
1313
:class: singlecol
1414

15-
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Confirms receipt of one existing alert.
15+
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Confirms receipt of one existing alert.
1616

1717
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.
1818

docs/command/atlas-api-alerts-getAlert.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ atlas api alerts getAlert
1212
:depth: 1
1313
:class: singlecol
1414

15-
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns one alert.
15+
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns one alert.
1616

1717
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.
1818

docs/command/atlas-api-alerts-listAlerts.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ atlas api alerts listAlerts
1212
:depth: 1
1313
:class: singlecol
1414

15-
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns all alerts.
15+
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all alerts.
1616

1717
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.
1818

docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ atlas api alerts listAlertsByAlertConfigurationId
1212
:depth: 1
1313
:class: singlecol
1414

15-
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns all open alerts that the specified alert configuration triggers.
15+
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all open alerts that the specified alert configuration triggers.
1616

1717
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.
1818

docs/command/atlas-api-alerts.txt

+5-5
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ atlas api alerts
1212
:depth: 1
1313
:class: singlecol
1414

15-
`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.
15+
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define.
1616

1717
This collection remains under revision and may change.
1818

@@ -51,10 +51,10 @@ Inherited Options
5151
Related Commands
5252
----------------
5353

54-
* :ref:`atlas-api-alerts-acknowledgeAlert` - `experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Confirms receipt of one existing alert.
55-
* :ref:`atlas-api-alerts-getAlert` - `experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns one alert.
56-
* :ref:`atlas-api-alerts-listAlerts` - `experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns all alerts.
57-
* :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.
54+
* :ref:`atlas-api-alerts-acknowledgeAlert` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Confirms receipt of one existing alert.
55+
* :ref:`atlas-api-alerts-getAlert` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns one alert.
56+
* :ref:`atlas-api-alerts-listAlerts` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all alerts.
57+
* :ref:`atlas-api-alerts-listAlertsByAlertConfigurationId` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all open alerts that the specified alert configuration triggers.
5858

5959

6060
.. toctree::

docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ atlas api atlasSearch createAtlasSearchDeployment
1212
:depth: 1
1313
:class: singlecol
1414

15-
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Creates Search Nodes for the specified cluster.
15+
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Creates Search Nodes for the specified cluster.
1616

1717
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.
1818

docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ atlas api atlasSearch createAtlasSearchIndex
1212
:depth: 1
1313
:class: singlecol
1414

15-
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Creates one Atlas Search index on the specified collection.
15+
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Creates one Atlas Search index on the specified collection.
1616

1717
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.
1818

docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ atlas api atlasSearch createAtlasSearchIndexDeprecated
1212
:depth: 1
1313
:class: singlecol
1414

15-
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Creates one Atlas Search index on the specified collection.
15+
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Creates one Atlas Search index on the specified collection.
1616

1717
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.
1818

docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ atlas api atlasSearch deleteAtlasSearchDeployment
1212
:depth: 1
1313
:class: singlecol
1414

15-
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Deletes the Search Nodes for the specified cluster.
15+
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Deletes the Search Nodes for the specified cluster.
1616

1717
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.
1818

docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ atlas api atlasSearch deleteAtlasSearchIndex
1212
:depth: 1
1313
:class: singlecol
1414

15-
`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Removes one Atlas Search index that you identified with its unique ID.
15+
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Removes one Atlas Search index that you identified with its unique ID.
1616

1717
To use this resource, the requesting API key must have the Project Data Access Admin role. This deletion is eventually consistent.
1818

0 commit comments

Comments
 (0)