Skip to content

Commit e6e6fbf

Browse files
CLOUDP-313028: Improve atlas api command docs to indicate only the commands are in public preview, not the features (#3908)
1 parent ad444c4 commit e6e6fbf

File tree

916 files changed

+5905
-1015
lines changed

Some content is hidden

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

916 files changed

+5905
-1015
lines changed

docs/command/atlas-accessLists-create.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ atlas accessLists create
1414

1515
Create an IP access list entry for your project.
1616

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
1722
The access list can contain trusted IP addresses, AWS security group IDs, and entries in Classless Inter-Domain Routing (CIDR) notation. You can add only one access list entry at a time. You can create one access list per project.
1823

1924
The command doesn't overwrite existing entries in the access list. Instead, it adds the new entries to the list of entries.

docs/command/atlas-accessLists-delete.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ atlas accessLists delete
1414

1515
Remove the specified IP access list entry from your project.
1616

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
1722
The command, when run without the force option, prompts you to confirm the operation.
1823

1924
To use this command, you must authenticate with a user account or an API key with the Read Write role.

docs/command/atlas-accessLists-describe.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ atlas accessLists describe
1414

1515
Return the details for the specified IP access list entry.
1616

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
1722
To use this command, you must authenticate with a user account or an API key with the Organization Member role.
1823

1924
Syntax

docs/command/atlas-accessLists-list.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ atlas accessLists list
1414

1515
Return all IP access list entries for your project.
1616

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
1722
To use this command, you must authenticate with a user account or an API key with the Organization Member role.
1823

1924
Syntax

docs/command/atlas-accessLists.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ atlas accessLists
1414

1515
Manage the list of IP addresses that can access your Atlas project.
1616

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
22+
23+
1724
Options
1825
-------
1926

docs/command/atlas-accessLogs-list.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ atlas accessLogs list
1414

1515
Retrieve the access logs of a cluster identified by the cluster's name or hostname.
1616

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
1722
To use this command, you must authenticate with a user account or an API key with the Project Monitoring Admin role.
1823

1924
Syntax

docs/command/atlas-accessLogs.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ atlas accessLogs
1414

1515
Return the access logs for a cluster.
1616

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
22+
23+
1724
Options
1825
-------
1926

docs/command/atlas-alerts-acknowledge.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ atlas alerts acknowledge
1414

1515
Acknowledges the specified alert for your project.
1616

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
1722
To use this command, you must authenticate with a user account or an API key with the Project Owner role.
1823

1924
Syntax

docs/command/atlas-alerts-describe.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ atlas alerts describe
1414

1515
Return the details for the specified alert for your project.
1616

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
1722
To use this command, you must authenticate with a user account or an API key with the Project Read Only role.
1823

1924
Syntax

docs/command/atlas-alerts-list.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ atlas alerts list
1414

1515
Return all alerts for your project.
1616

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
1722
To use this command, you must authenticate with a user account or an API key with the Project Read Only role.
1823

1924
Syntax

docs/command/atlas-alerts-settings-create.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ atlas alerts settings create
1414

1515
Create an alert configuration for your project.
1616

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
1722
To use this command, you must authenticate with a user account or an API key with the Project Owner role.
1823

1924
Syntax

docs/command/atlas-alerts-settings-delete.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ atlas alerts settings delete
1414

1515
Remove the specified alert configuration for your project.
1616

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
1722
To use this command, you must authenticate with a user account or an API key with the Project Owner role.
1823

1924
Syntax

docs/command/atlas-alerts-settings-describe.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ atlas alerts settings describe
1414

1515
Return the details for the specified alert settings for your project.
1616

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
1722
To use this command, you must authenticate with a user account or an API key with the Project Read Only role.
1823

1924
Syntax

docs/command/atlas-alerts-settings-disable.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ atlas alerts settings disable
1414

1515
Disables one alert configuration for the specified project.
1616

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
22+
23+
1724
Syntax
1825
------
1926

docs/command/atlas-alerts-settings-enable.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ atlas alerts settings enable
1414

1515
Enables one alert configuration for the specified project.
1616

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
22+
23+
1724
Syntax
1825
------
1926

docs/command/atlas-alerts-settings-fields-type.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ atlas alerts settings fields type
1414

1515
Return all available field types that the matcherFieldName option accepts when you create or update an alert configuration.
1616

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
1722
To use this command, you must authenticate with a user account or an API key with the Project Read Only role.
1823

1924
Syntax

docs/command/atlas-alerts-settings-fields.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ atlas alerts settings fields
1414

1515
Manages alert configuration fields for your project.
1616

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
22+
23+
1724
Options
1825
-------
1926

docs/command/atlas-alerts-settings-list.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ atlas alerts settings list
1414

1515
Returns all alert configurations for your project.
1616

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
1722
To use this command, you must authenticate with a user account or an API key with the Project Read Only role.
1823

1924
Syntax

docs/command/atlas-alerts-settings-update.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ atlas alerts settings update
1414

1515
Modify the details of the specified alert configuration for your project.
1616

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
1722
To use this command, you must authenticate with a user account or an API key with the Project Owner role.
1823

1924
Syntax

docs/command/atlas-alerts-settings.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ atlas alerts settings
1414

1515
Manages alerts configuration for your project.
1616

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
1722
Use this command to list, create, edit, delete, enable and disable alert configurations.
1823

1924
Options

docs/command/atlas-alerts-unacknowledge.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ atlas alerts unacknowledge
1414

1515
Unacknowledge the specified alert for your project.
1616

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
1722
To use this command, you must authenticate with a user account or an API key with the Project Owner role.
1823

1924
Syntax

docs/command/atlas-alerts.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ atlas alerts
1414

1515
Manage alerts for your project.
1616

17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
22+
23+
1724
Options
1825
-------
1926

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,12 @@ atlas api accessTracking listAccessLogsByClusterName
1212
:depth: 1
1313
:class: singlecol
1414

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.
15+
`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the access logs of one cluster identified by the cluster's name.
16+
17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
1621

1722
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 Service Account or API Key must have the Project Monitoring Admin role or the Project Database Access Admin role.
1823

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,12 @@ atlas api accessTracking listAccessLogsByHostname
1212
:depth: 1
1313
:class: singlecol
1414

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.
15+
`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the access logs of one cluster identified by the cluster's hostname.
16+
17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
1621

1722
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 Service Account or API Key must have the Project Monitoring Admin role or the Project Database Access Admin role.
1823

docs/command/atlas-api-accessTracking.txt

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,12 @@ atlas api accessTracking
1212
:depth: 1
1313
:class: singlecol
1414

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.
15+
`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns access logs for authentication attempts made to Atlas database deployments.
16+
17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
1621

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

@@ -51,8 +56,8 @@ Inherited Options
5156
Related Commands
5257
----------------
5358

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

5762

5863
.. toctree::

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,12 @@ atlas api alertConfigurations createAlertConfiguration
1212
:depth: 1
1313
:class: singlecol
1414

15-
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Creates one alert configuration for the specified project.
15+
`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Creates one alert configuration for the specified project.
16+
17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
1621

1722
Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role.
1823

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,12 @@ atlas api alertConfigurations deleteAlertConfiguration
1212
:depth: 1
1313
:class: singlecol
1414

15-
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Removes one alert configuration from the specified project.
15+
`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Removes one alert configuration from the specified project.
16+
17+
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
1621

1722
To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access.
1823

0 commit comments

Comments
 (0)