Skip to content

CLOUDP-329977: [Atlas CLI] The api "public preview" message is appearing in all CLI docs #4037

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jeroenvervaeke
Copy link
Collaborator

Proposed changes

  • Removed 'experimental' text from common commands
  • Improved docs for 'atlas api' commands

Jira ticket: CLOUDP-329977

Testing

  • Verified docs and help text for:
    • L2 commands (root and child commands)
    • atlas api commands

L1: root

❯ ./bin/atlas api networkPeering --help
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).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

Returns, adds, edits, and removes network peering containers and peering connections. When you deploy an M10+ dedicated cluster, Atlas creates a VPC for the selected provider and region or regions if no existing VPC or VPC peering connection exists for that provider and region. Atlas assigns the VPC a Classless Inter-Domain Routing (CIDR) block.

Usage:
  atlas api networkPeering [command]

Available Commands:
  createPeeringConnection                      Creates one new network peering connection in the specified project.
  createPeeringContainer                       Creates one new network peering container in the specified project.
  deletePeeringConnection                      Removes one network peering connection in the specified project.

L1: child

❯ ./bin/atlas api networkPeering disablePeering --help
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).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

Disables Connect via Peering Only mode for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-disablepeering.

For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-networkPeering-disablePeering/

Usage:
  atlas api networkPeering disablePeering [flags]

Flags:
      --envelope            flag that indicates whether Application wraps the response in an envelope JSON object

L2: root

❯ ./bin/atlas cluster --help
Manage clusters for your project. The clusters command provides access to your cluster configurations. You can create, edit, and delete clusters.

Usage:
  atlas clusters [command]

L2: child

❯ ./bin/atlas cluster create --help
Create a cluster for your project. To get started quickly, specify a name for your cluster, a cloud provider, and a region to deploy a three-member replica set with the latest MongoDB server version.
For full control of your deployment, or to create multi-cloud clusters, provide a JSON configuration file with the --file flag.

Deprecation note: the M2 and M5 tiers are now deprecated; when selecting M2 or M5, a FLEX tier will be created instead. For the migration guide, visit: https://dochub.mongodb.org/core/flex-migration.\n

@jeroenvervaeke jeroenvervaeke requested review from a team as code owners July 11, 2025 10:07
Copy link
Collaborator

@andreaangiolillo andreaangiolillo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

Coverage Report 📈

Branch Commit Coverage
master a1fb341 25.7%
CLOUDP-329977 0d66f24 25.7%
Difference 0%

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants