Skip to content

CLOUDP-347241: Remove all references to public preview in L1 commands #4234

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.

Sign up for GitHub

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

Merged
merged 11 commits into from
Oct 6, 2025
Merged

CLOUDP-347241: Remove all references to public preview in L1 commands #4234

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
c7d7556
Remove public preview from docs generation
Luke-Sanderson Sep 25, 2025
9a14f2f
Remove api specific public preview help template
Luke-Sanderson Sep 25, 2025
da572f8
Run make gen-docs
Luke-Sanderson Sep 25, 2025
c8b2513
golint space
Luke-Sanderson Sep 25, 2025
73a380e
Re-add api help docs template
Luke-Sanderson Sep 25, 2025
53b81e6
Variable Rename and re-add long-text api autogeneration disclaimer
Luke-Sanderson Sep 26, 2025
9c6099b
run make gen-docs
Luke-Sanderson Sep 26, 2025
eb0281d
PR suggestion
Luke-Sanderson Sep 26, 2025
fdca45e
Docs comments
Luke-Sanderson Oct 6, 2025
f1bb6d8
Docs comments
Luke-Sanderson Oct 6, 2025
5aaf927
run make gen-docs
Luke-Sanderson Oct 6, 2025
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
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ atlas api accessTracking listAccessLogsByClusterName
:depth: 1
:class: singlecol

`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.
Returns the access logs of one cluster identified by the cluster's name.

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).
The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API.
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

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.
Expand Down
4 changes: 2 additions & 2 deletions docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ atlas api accessTracking listAccessLogsByHostname
:depth: 1
:class: singlecol

`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.
Returns the access logs of one cluster identified by the cluster's hostname.

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).
The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API.
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

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.
Expand Down
8 changes: 4 additions & 4 deletions docs/command/atlas-api-accessTracking.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ atlas api accessTracking
:depth: 1
:class: singlecol

`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns access logs for authentication attempts made to Atlas database deployments.
Returns access logs for authentication attempts made to Atlas database deployments.

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).
The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API.
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

To view database access history, you must have either the Project Owner or Organization Owner role.
Expand Down Expand Up @@ -54,8 +54,8 @@ Inherited Options
Related Commands
----------------

* :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.
* :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.
* :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.


.. toctree::
Expand Down
4 changes: 2 additions & 2 deletions docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ atlas api alertConfigurations createAlertConfiguration
:depth: 1
:class: singlecol

`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Creates one alert configuration for the specified project.
Creates one alert configuration for the specified project.

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).
The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API.
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

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.
Expand Down
4 changes: 2 additions & 2 deletions docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ atlas api alertConfigurations deleteAlertConfiguration
:depth: 1
:class: singlecol

`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Removes one alert configuration from the specified project.
Removes one alert configuration from the specified project.

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).
The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API.
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

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.
Expand Down
4 changes: 2 additions & 2 deletions docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ atlas api alertConfigurations getAlertConfiguration
:depth: 1
:class: singlecol

`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the specified alert configuration from the specified project.
Returns the specified alert configuration from the specified project.

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).
The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API.
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access.
Expand Down
4 changes: 2 additions & 2 deletions docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ atlas api alertConfigurations listAlertConfigurationMatchersFieldNames
:depth: 1
:class: singlecol

`Public Preview: please provide feedback <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.
Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration.

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).
The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API.
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

You can successfully call this endpoint with any assigned role.
Expand Down
4 changes: 2 additions & 2 deletions docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ atlas api alertConfigurations listAlertConfigurations
:depth: 1
:class: singlecol

`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all alert configurations for one project.
Returns all alert configurations for one project.

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).
The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API.
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

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 Service Account or API Key must have the Project Read Only role.
Expand Down
4 changes: 2 additions & 2 deletions docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ atlas api alertConfigurations listAlertConfigurationsByAlertId
:depth: 1
:class: singlecol

`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all alert configurations set for the specified alert.
Returns all alert configurations set for the specified alert.

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).
The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API.
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access.
Expand Down
4 changes: 2 additions & 2 deletions docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ atlas api alertConfigurations toggleAlertConfiguration
:depth: 1
:class: singlecol

`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Enables or disables the specified alert configuration in the specified project.
Enables or disables the specified alert configuration in the specified project.

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).
The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API.
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

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 Service Account or API Key must have the Organization Owner or Project Owner role.
Expand Down
4 changes: 2 additions & 2 deletions docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ atlas api alertConfigurations updateAlertConfiguration
:depth: 1
:class: singlecol

`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Updates one alert configuration in the specified project.
Updates one alert configuration in the specified project.

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).
The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API.
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

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.
Expand Down
20 changes: 10 additions & 10 deletions docs/command/atlas-api-alertConfigurations.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ atlas api alertConfigurations
:depth: 1
:class: singlecol

`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users.
Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users.

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).
The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API.
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

This collection remains under revision and may change.
Expand Down Expand Up @@ -54,14 +54,14 @@ Inherited Options
Related Commands
----------------

* :ref:`atlas-api-alertConfigurations-createAlertConfiguration` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Creates one alert configuration for the specified project.
* :ref:`atlas-api-alertConfigurations-deleteAlertConfiguration` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Removes one alert configuration from the specified project.
* :ref:`atlas-api-alertConfigurations-getAlertConfiguration` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the specified alert configuration from the specified project.
* :ref:`atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames` - `Public Preview: please provide feedback <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.
* :ref:`atlas-api-alertConfigurations-listAlertConfigurations` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all alert configurations for one project.
* :ref:`atlas-api-alertConfigurations-listAlertConfigurationsByAlertId` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all alert configurations set for the specified alert.
* :ref:`atlas-api-alertConfigurations-toggleAlertConfiguration` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Enables or disables the specified alert configuration in the specified project.
* :ref:`atlas-api-alertConfigurations-updateAlertConfiguration` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Updates one alert configuration in the specified project.
* :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.


.. toctree::
Expand Down
4 changes: 2 additions & 2 deletions docs/command/atlas-api-alerts-acknowledgeAlert.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ atlas api alerts acknowledgeAlert
:depth: 1
:class: singlecol

`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Confirms receipt of one existing alert.
Confirms receipt of one existing alert.

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).
The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API.
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

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 Service Account or API Key must have the Organization Owner or Project Owner role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access.
Expand Down
4 changes: 2 additions & 2 deletions docs/command/atlas-api-alerts-getAlert.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ atlas api alerts getAlert
:depth: 1
:class: singlecol

`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns one alert.
Returns one alert.

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).
The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API.
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

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 Service Account or API Key must have the Project Read Only role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access.
Expand Down
4 changes: 2 additions & 2 deletions docs/command/atlas-api-alerts-listAlerts.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ atlas api alerts listAlerts
:depth: 1
:class: singlecol

`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all alerts.
Returns all alerts.

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).
The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API.
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

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 Service Account or API Key must have the Project Read Only role.
Expand Down
Loading
Loading