-
Type:
Task
-
Resolution: Done
-
Priority:
Major - P3
-
None
-
Affects Version/s: None
-
Component/s: Atlas SQL Interface
-
Atlas SQL
-
Not Needed
This task is to be done closer to when the SQL Interface system is fully supported.
Promote both GET and PATCH for /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/sqlInterface from private preview to public preview so the endpoint can move forward for Atlas CLI support.
The Atlas Versioned Admin API Lifecycle doc says public preview should keep the preview media type application/vnd.atlas.preview+json, keep x-xgen-version = preview, and set x-xgen-preview with public = "true".
Verify the endpoint appears in the expected downstream API surface for Atlas CLI and related tooling workflows.
See step 4 of this documentation:
https://wiki.corp.mongodb.com/spaces/MMS/pages/314680401/Atlas+Versioned+Admin+API+Lifecycle#AtlasVersionedAdminAPILifecycle-HowtodefineaPreviewAPI
Only for Public Preview API:
- Add the extension "x-gen-preview" with the "name" property sets to "public" (Example) to API Response.
x-gen-preview for Public Preview APIs
@Extension( name = "x-xgen-preview", properties = { @ExtensionProperty(name = "public", value = "true")) } )
- (Optional - it depends if the endpoint has a request body) Add the extension "x-gen-preview" with the "name" property sets to "public" to Request body