CLOUDP-345026: Update the L1 generation tool to support x-xgen-operation-id-override

CONTRIBUTING.md

@@ -188,6 +188,15 @@ Before adding a command please make sure that your api exists in the GO SDK.
 > [!TIP]  
 > Atlas CLI provides an experimental generator, make sure to try it out in [tools/cli-generator](./tools/cli-generator)
 
+### Making changes to API Generator
+
+API generator is a tool that generates code based on Atlas OpenAPI specification.
+It is used to generate `./internal/api/commands.go` file that contains all API commands.
+
+If you are making changes to the generator please make sure to run `make gen-api-commands` to update the generated code. 
+
+Please also run `UPDATE_SNAPSHOTS=true go test ./...` from the `tools/cmd/api-generator` directory to update the snapshots. When you run the command for the first time it will fail, showing the diff. Upon running the command again the test will pass as the snapshots have been updated.
+
 ### API Interactions
 
 Atlas CLI use [atlas-sdk-go](https://github.com/mongodb/atlas-sdk-go) for all backend integration.

internal/cli/api/api.go

@@ -99,6 +99,17 @@ func createAPICommandGroupToCobraCommand(group shared_api.Group) *cobra.Command
 func convertAPIToCobraCommand(command shared_api.Command) (*cobra.Command, error) {
 	// command properties
 	commandName := strcase.ToLowerCamel(command.OperationID)
+	commandOperationID := command.OperationID
+	commandAliases := command.Aliases
+
+	if command.ShortOperationID != "" {
+		// Add original operation ID to aliases
+		commandAliases = append(commandAliases, commandName)
+		// Use shortOperationID
+		commandName = strcase.ToLowerCamel(command.ShortOperationID)
+		commandOperationID = command.ShortOperationID
+	}
+
 	shortDescription, longDescription := splitShortAndLongDescription(command.Description)
 
 	// flag values
@@ -114,11 +125,11 @@ func convertAPIToCobraCommand(command shared_api.Command) (*cobra.Command, error
 
 	cmd := &cobra.Command{
 		Use:     commandName,
-		Aliases: command.Aliases,
+		Aliases: commandAliases,
 		Short:   shortDescription,
 		Long:    longDescription,
 		Annotations: map[string]string{
-			"operationId": command.OperationID,
+			"operationId": commandOperationID,
 		},
 		PreRunE: func(cmd *cobra.Command, _ []string) error {
 			// Go through all commands that have not been touched/modified by the user and try to populate them from the users profile

tools/cmd/api-generator/commands.go.tmpl

@@ -33,8 +33,9 @@ var Commands = shared_api.GroupedAndSortedCommands{
 		Commands: []shared_api.Command{
 		{{- range .Commands }}
 			{
-				OperationID: `{{ .OperationID }}`,
-				Aliases: {{if not .Aliases}} nil {{else}} []string{ {{ range $i, $alias := .Aliases }}{{if $i}},{{end}}`{{ $alias }}`{{end}} } {{end}},
+				OperationID:      `{{ .OperationID }}`,
+				ShortOperationID: `{{ .ShortOperationID }}`,
+				Aliases:          {{if not .Aliases}} nil {{else}} []string{ {{ range $i, $alias := .Aliases }}{{if $i}},{{end}}`{{ $alias }}`{{end}} } {{end}},
 				Description: `{{ .Description }}`,
 				RequestParameters: shared_api.RequestParameters{
 					URL: `{{ .RequestParameters.URL }}`,

tools/cmd/api-generator/convert_commands.go

@@ -101,16 +101,22 @@ func extractSunsetDate(extensions map[string]any) *time.Time {
 type operationExtensions struct {
 	skip             bool
 	operationID      string
+	shortOperationID string
 	operationAliases []string
 }
 
 func extractExtensionsFromOperation(operation *openapi3.Operation) operationExtensions {
 	ext := operationExtensions{
 		skip:             false,
 		operationID:      operation.OperationID,
+		shortOperationID: "",
 		operationAliases: []string{},
 	}
 
+	if shortOperationID, ok := operation.Extensions["x-xgen-operation-id-override"].(string); ok && shortOperationID != "" {
+		ext.shortOperationID = shortOperationID
+	}
+
 	if extensions, okExtensions := operation.Extensions["x-xgen-atlascli"].(map[string]any); okExtensions && extensions != nil {
 		if extSkip, okSkip := extensions["skip"].(bool); okSkip && extSkip {
 			ext.skip = extSkip
@@ -124,9 +130,11 @@ func extractExtensionsFromOperation(operation *openapi3.Operation) operationExte
 			}
 		}
 
+		// OperationID override for x-xgen-atlascli. This takes priority over x-xgen-operation-id-override.
 		if overrides := extractOverrides(operation.Extensions); overrides != nil {
 			if overriddenOperationID, ok := overrides["operationId"].(string); ok && overriddenOperationID != "" {
 				ext.operationID = overriddenOperationID
+				ext.shortOperationID = ""
 			}
 		}
 	}
@@ -141,6 +149,7 @@ func operationToCommand(now time.Time, path, verb string, operation *openapi3.Op
 	}
 
 	operationID := extensions.operationID
+	shortOperationID := extensions.shortOperationID
 	aliases := extensions.operationAliases
 
 	httpVerb, err := api.ToHTTPVerb(verb)
@@ -179,9 +188,10 @@ func operationToCommand(now time.Time, path, verb string, operation *openapi3.Op
 	}
 
 	command := api.Command{
-		OperationID: operationID,
-		Aliases:     aliases,
-		Description: description,
+		OperationID:      operationID,
+		ShortOperationID: shortOperationID,
+		Aliases:          aliases,
+		Description:      description,
 		RequestParameters: api.RequestParameters{
 			URL:             path,
 			QueryParameters: parameters.query,

tools/cmd/api-generator/testdata/.snapshots/00-spec.yaml-commands.snapshot

@@ -29,8 +29,9 @@ var Commands = shared_api.GroupedAndSortedCommands{
 		Description: `Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs. This resource requires your Project ID.`,
 		Commands: []shared_api.Command{
 			{
-				OperationID: `createCluster`,
-				Aliases:     nil,
+				OperationID:      `createCluster`,
+				ShortOperationID: ``,
+				Aliases:          nil,
 				Description: `Creates one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can create clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters.
 
 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-createcluster.
@@ -109,8 +110,9 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you
 				},
 			},
 			{
-				OperationID: `listClusters`,
-				Aliases:     nil,
+				OperationID:      `listClusters`,
+				ShortOperationID: ``,
+				Aliases:          nil,
 				Description: `Returns the details for all clusters in the specific project to which you have access. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not  available for serverless clusters.
 
 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-listclusters.

tools/cmd/api-generator/testdata/.snapshots/01-missing-tag.yaml-commands.snapshot

@@ -29,8 +29,9 @@ var Commands = shared_api.GroupedAndSortedCommands{
 		Description: ``,
 		Commands: []shared_api.Command{
 			{
-				OperationID: `createCluster`,
-				Aliases:     nil,
+				OperationID:      `createCluster`,
+				ShortOperationID: ``,
+				Aliases:          nil,
 				Description: `Creates one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can create clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters.
 
 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-createcluster.
@@ -109,8 +110,9 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you
 				},
 			},
 			{
-				OperationID: `listClusters`,
-				Aliases:     nil,
+				OperationID:      `listClusters`,
+				ShortOperationID: ``,
+				Aliases:          nil,
 				Description: `Returns the details for all clusters in the specific project to which you have access. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not  available for serverless clusters.
 
 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-listclusters.

tools/cmd/api-generator/testdata/.snapshots/02-multiple-content-types.yaml-commands.snapshot

@@ -29,8 +29,9 @@ var Commands = shared_api.GroupedAndSortedCommands{
 		Description: `Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs. This resource requires your Project ID.`,
 		Commands: []shared_api.Command{
 			{
-				OperationID: `createCluster`,
-				Aliases:     nil,
+				OperationID:      `createCluster`,
+				ShortOperationID: ``,
+				Aliases:          nil,
 				Description: `Creates one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can create clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters.
 
 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-createcluster.
@@ -109,8 +110,9 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you
 				},
 			},
 			{
-				OperationID: `listClusters`,
-				Aliases:     nil,
+				OperationID:      `listClusters`,
+				ShortOperationID: ``,
+				Aliases:          nil,
 				Description: `Returns the details for all clusters in the specific project to which you have access. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not  available for serverless clusters.
 
 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-listclusters.

tools/cmd/api-generator/testdata/.snapshots/03-nested-parameter-types.yaml-commands.snapshot

@@ -29,8 +29,9 @@ var Commands = shared_api.GroupedAndSortedCommands{
 		Description: `Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs. This resource requires your Project ID.`,
 		Commands: []shared_api.Command{
 			{
-				OperationID: `getCollStatsLatencyNamespaceClusterMeasurements`,
-				Aliases:     nil,
+				OperationID:      `getCollStatsLatencyNamespaceClusterMeasurements`,
+				ShortOperationID: ``,
+				Aliases:          nil,
 				Description: `Get a list of the Coll Stats Latency cluster-level measurements for the given namespace.
 
 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-getcollstatslatencynamespaceclustermeasurements.

tools/cmd/api-generator/testdata/.snapshots/04-spec-with-overrides.yaml-commands.snapshot

@@ -29,8 +29,9 @@ var Commands = shared_api.GroupedAndSortedCommands{
 		Description: `Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs. This resource requires your Project ID.`,
 		Commands: []shared_api.Command{
 			{
-				OperationID: `createClusterX`,
-				Aliases:     nil,
+				OperationID:      `createClusterX`,
+				ShortOperationID: ``,
+				Aliases:          nil,
 				Description: `OVERRIDDEN
 
 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-createcluster.

tools/cmd/api-generator/testdata/.snapshots/05-examples.yaml-commands.snapshot

@@ -29,8 +29,9 @@ var Commands = shared_api.GroupedAndSortedCommands{
 		Description: `Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs. This resource requires your Project ID.`,
 		Commands: []shared_api.Command{
 			{
-				OperationID: `createCluster`,
-				Aliases:     nil,
+				OperationID:      `createCluster`,
+				ShortOperationID: ``,
+				Aliases:          nil,
 				Description: `Creates one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can create clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters.
 
 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-createcluster.
@@ -109,8 +110,9 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you
 				},
 			},
 			{
-				OperationID: `listClusters`,
-				Aliases:     nil,
+				OperationID:      `listClusters`,
+				ShortOperationID: ``,
+				Aliases:          nil,
 				Description: `Returns the details for all clusters in the specific project to which you have access. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not  available for serverless clusters.
 
 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-listclusters.

tools/cmd/api-generator/testdata/.snapshots/06-spec-with-cli-specific-extensions.yaml-commands.snapshot

@@ -29,8 +29,9 @@ var Commands = shared_api.GroupedAndSortedCommands{
 		Description: `Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs. This resource requires your Project ID.`,
 		Commands: []shared_api.Command{
 			{
-				OperationID: `createCluster`,
-				Aliases:     []string{`createDatabase`, `createServer`},
+				OperationID:      `createCluster`,
+				ShortOperationID: ``,
+				Aliases:          []string{`createDatabase`, `createServer`},
 				Description: `Creates one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can create clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters.
 
 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-createcluster.

tools/cmd/api-generator/testdata/.snapshots/07-sunset.yaml-commands.snapshot

@@ -29,8 +29,9 @@ var Commands = shared_api.GroupedAndSortedCommands{
 		Description: `Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs. This resource requires your Project ID.`,
 		Commands: []shared_api.Command{
 			{
-				OperationID: `listClusters`,
-				Aliases:     nil,
+				OperationID:      `listClusters`,
+				ShortOperationID: ``,
+				Aliases:          nil,
 				Description: `Returns the details for all clusters in the specific project to which you have access. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not  available for serverless clusters.
 
 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-listclusters.

tools/cmd/api-generator/testdata/.snapshots/08-watchers.yaml-commands.snapshot

@@ -29,8 +29,9 @@ var Commands = shared_api.GroupedAndSortedCommands{
 		Description: `Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs. This resource requires your Project ID.`,
 		Commands: []shared_api.Command{
 			{
-				OperationID: `createCluster`,
-				Aliases:     []string{`createDatabase`, `createServer`},
+				OperationID:      `createCluster`,
+				ShortOperationID: ``,
+				Aliases:          []string{`createDatabase`, `createServer`},
 				Description: `Creates one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can create clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters.
 
 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-createcluster.
@@ -128,8 +129,9 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you
 				},
 			},
 			{
-				OperationID: `getCluster`,
-				Aliases:     nil,
+				OperationID:      `getCluster`,
+				ShortOperationID: ``,
+				Aliases:          nil,
 				Description: `Returns the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters.
 
 

tools/cmd/api-generator/testdata/.snapshots/09-stability-level-private-preview.yaml-commands.snapshot

@@ -29,8 +29,9 @@ var Commands = shared_api.GroupedAndSortedCommands{
 		Description: `Returns, adds, and edits Charts Dashboard instances. This resource applies only to projects with a Charts tenant, and requires your Project ID.`,
 		Commands: []shared_api.Command{
 			{
-				OperationID: `exportChartsDashboard`,
-				Aliases:     nil,
+				OperationID:      `exportChartsDashboard`,
+				ShortOperationID: ``,
+				Aliases:          nil,
 				Description: `Exports the specified Charts dashboard. To use this resource, the requesting Service Account or API Key must have the Project Read Only 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-exportchartsdashboard.

tools/cmd/api-generator/testdata/.snapshots/10-stability-level-public-preview.yaml-commands.snapshot

@@ -29,8 +29,9 @@ var Commands = shared_api.GroupedAndSortedCommands{
 		Description: `Returns, adds, and edits Charts Dashboard instances. This resource applies only to projects with a Charts tenant, and requires your Project ID.`,
 		Commands: []shared_api.Command{
 			{
-				OperationID: `exportChartsDashboard`,
-				Aliases:     nil,
+				OperationID:      `exportChartsDashboard`,
+				ShortOperationID: ``,
+				Aliases:          nil,
 				Description: `Exports the specified Charts dashboard. To use this resource, the requesting Service Account or API Key must have the Project Read Only 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-exportchartsdashboard.

tools/cmd/api-generator/testdata/.snapshots/11-stability-level-upcoming.yaml-commands.snapshot

@@ -29,8 +29,9 @@ var Commands = shared_api.GroupedAndSortedCommands{
 		Description: `Returns, adds, and edits Charts Dashboard instances. This resource applies only to projects with a Charts tenant, and requires your Project ID.`,
 		Commands: []shared_api.Command{
 			{
-				OperationID: `exportChartsDashboard`,
-				Aliases:     nil,
+				OperationID:      `exportChartsDashboard`,
+				ShortOperationID: ``,
+				Aliases:          nil,
 				Description: `Exports the specified Charts dashboard. To use this resource, the requesting Service Account or API Key must have the Project Read Only 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-exportchartsdashboard.