interface name change

Author: Pan Shao

packages/extensions/openapi-to-typespec/src/transforms/transform-arm-resources.ts

@@ -1,6 +1,6 @@
 import { Operation, Parameter, Property, SchemaType } from "@autorest/codemodel";
 import _ from "lodash";
-import pluralize, { singular } from "pluralize";
+import { singular } from "pluralize";
 import { getSession } from "../autorest-session";
 import { getDataTypes } from "../data-types";
 import {
@@ -49,6 +49,7 @@ import {
 import { getFullyQualifiedName, getTemplateResponses, NamesOfResponseTemplate } from "../utils/type-mapping";
 import { getTypespecType, isTypespecType, transformObjectProperty } from "./transform-object";
 import { transformParameter } from "./transform-operations";
+import { getTSPOperationGroupName } from "../utils/operation-group";
 
 const logger = () => getLogger("transform-arm-resources");
 
@@ -893,35 +894,6 @@ function getOtherProperties(
   return otherProperties;
 }
 
-const operationGroupNameCache: Map<ArmResource, string> = new Map<ArmResource, string>();
-export function getTSPOperationGroupName(resourceMetadata: ArmResource): string {
-  if (operationGroupNameCache.has(resourceMetadata)) return operationGroupNameCache.get(resourceMetadata)!;
-
-  // Try pluralizing the resource name first
-  let operationGroupName = pluralize(resourceMetadata.SwaggerModelName);
-  if (operationGroupName !== resourceMetadata.SwaggerModelName && !isExistingOperationGroupName(operationGroupName)) {
-    operationGroupNameCache.set(resourceMetadata, operationGroupName);
-  } else {
-    // Try operationId then
-    operationGroupName = resourceMetadata.GetOperation!.OperationID.split("_")[0];
-    if (operationGroupName !== resourceMetadata.SwaggerModelName && !isExistingOperationGroupName(operationGroupName)) {
-      operationGroupNameCache.set(resourceMetadata, operationGroupName);
-    } else {
-      operationGroupName = `${resourceMetadata.SwaggerModelName}OperationGroup`;
-      operationGroupNameCache.set(resourceMetadata, operationGroupName);
-    }
-  }
-  return operationGroupName;
-}
-
-function isExistingOperationGroupName(operationGroupName: string): boolean {
-  const codeModel = getSession().model;
-  return (
-    codeModel.schemas.objects?.find((o) => o.language.default.name === operationGroupName) !== undefined ||
-    Array.from(operationGroupNameCache.values()).find((v) => v === operationGroupName) !== undefined
-  );
-}
-
 function getBodyDecorators(
   bodyParam: Parameter | undefined,
   tspOperationGroupName: string,

packages/extensions/openapi-to-typespec/src/transforms/transform-operations.ts

@@ -30,15 +30,16 @@ import { getLogger } from "../utils/logger";
 import { getLanguageMetadata } from "../utils/metadata";
 import { generateAdditionalProperties, generateTemplateModel } from "../utils/model-generation";
 import { transformSchemaResponse } from "../utils/response";
-import { isArraySchema, isConstantSchema, isResponseSchema } from "../utils/schemas";
+import { isConstantSchema, isResponseSchema } from "../utils/schemas";
 import { getSuppressionWithCode, SuppressionCode } from "../utils/suppressions";
 import { getDefaultValue } from "../utils/values";
+import { getTSPNonResourceOperationGroupName } from "../utils/operation-group";
 
 export function transformOperationGroup(
   { language, operations }: OperationGroup,
   codeModel: CodeModel,
 ): TypespecOperationGroup {
-  const name = language.default.name ? `${language.default.name}Operations` : "";
+  const name = language.default.name ? getTSPNonResourceOperationGroupName(language.default.name) : "";
   const doc = language.default.description;
   const ops = operations.reduce<(TypespecOperation | TspArmProviderActionOperation)[]>((acc, op) => {
     acc = [...acc, ...transformOperation(op, codeModel, name)];

packages/extensions/openapi-to-typespec/src/utils/operation-group.ts

@@ -0,0 +1,43 @@
+import pluralize from "pluralize";
+import { ArmResource } from "./resource-discovery";
+import { getSession } from "../autorest-session";
+import { getOptions } from "../options";
+
+const operationGroupNameCache: Map<ArmResource, string> = new Map<ArmResource, string>();
+export function getTSPOperationGroupName(resourceMetadata: ArmResource): string {
+  if (operationGroupNameCache.has(resourceMetadata)) return operationGroupNameCache.get(resourceMetadata)!;
+
+  // Try pluralizing the resource name first
+  let operationGroupName = pluralize(resourceMetadata.SwaggerModelName);
+  if (operationGroupName !== resourceMetadata.SwaggerModelName && !isExistingOperationGroupName(operationGroupName)) {
+    operationGroupNameCache.set(resourceMetadata, operationGroupName);
+  } else {
+    // Try operationId then
+    operationGroupName = resourceMetadata.GetOperation!.OperationID.split("_")[0];
+    if (operationGroupName !== resourceMetadata.SwaggerModelName && !isExistingOperationGroupName(operationGroupName)) {
+      operationGroupNameCache.set(resourceMetadata, operationGroupName);
+    } else {
+      operationGroupName = `${resourceMetadata.SwaggerModelName}OperationGroup`;
+      operationGroupNameCache.set(resourceMetadata, operationGroupName);
+    }
+  }
+  return operationGroupName;
+}
+
+function isExistingOperationGroupName(operationGroupName: string): boolean {
+  const codeModel = getSession().model;
+  return (
+    codeModel.schemas.objects?.find((o) => o.language.default.name === operationGroupName) !== undefined ||
+    Array.from(operationGroupNameCache.values()).find((v) => v === operationGroupName) !== undefined
+  );
+}
+
+export function getTSPNonResourceOperationGroupName(name: string): string {
+  const operationGroupName = `${name}OperationGroup`;
+  if (!isExistingOperationGroupName(operationGroupName)) {
+    return operationGroupName;
+  }
+
+  // Arm resource operation group name cannot be ended with "Operations"
+  return getOptions().isArm ? `${name}NonResourceOperationGroup` : `${name}Operations`;
+}

packages/extensions/openapi-to-typespec/test/analyzeText/tsp-output/routes.tsp

@@ -9,7 +9,7 @@ using TypeSpec.OpenAPI;
 
 namespace Azure.Language.Authoring;
 
-interface TextAnalysisAuthoringOperations {
+interface TextAnalysisAuthoringOperationGroup {
   /**
    * Lists the existing projects.
    */

packages/extensions/openapi-to-typespec/test/arm-agrifood/tsp-output/routes.tsp

@@ -14,7 +14,7 @@ using TypeSpec.OpenAPI;
 namespace Microsoft.AgFoodPlatform;
 
 #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "For backward compatibility"
-interface CheckNameAvailabilityOperations {
+interface CheckNameAvailabilityOperationGroup {
   /**
    * Checks the name availability of the resource with requested resource name.
    */
@@ -30,7 +30,7 @@ interface CheckNameAvailabilityOperations {
 }
 
 #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "For backward compatibility"
-interface OperationResultsOperations {
+interface OperationResultsOperationGroup {
   /**
    * Get operationResults for a Data Manager For Agriculture resource.
    */

packages/extensions/openapi-to-typespec/test/arm-alertsmanagement/tsp-output/routes.tsp

@@ -14,7 +14,7 @@ using TypeSpec.OpenAPI;
 namespace Azure.ResourceManager.AlertsManagement;
 
 #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "For backward compatibility"
-interface AlertsOperations {
+interface AlertsOperationGroup {
   /**
    * List alerts meta data information based on value of identifier parameter.
    */

packages/extensions/openapi-to-typespec/test/arm-analysisservices/tsp-output/routes.tsp

@@ -14,7 +14,7 @@ using TypeSpec.OpenAPI;
 namespace Azure.ResourceManager.Analysis;
 
 #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "For backward compatibility"
-interface ServersOperations {
+interface ServersOperationGroup {
   /**
    * Lists eligible SKUs for Analysis Services resource provider.
    */

packages/extensions/openapi-to-typespec/test/arm-apimanagement/tsp-output/routes.tsp

@@ -14,7 +14,7 @@ using TypeSpec.OpenAPI;
 namespace Azure.ResourceManager.ApiManagement;
 
 #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "For backward compatibility"
-interface ApiExportOperations {
+interface ApiExportOperationGroup {
   /**
    * Gets the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes.
    */
@@ -61,7 +61,7 @@ interface ApiExportOperations {
 }
 
 #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "For backward compatibility"
-interface DeletedServicesOperations {
+interface DeletedServicesOperationGroup {
   /**
    * Lists all soft-deleted services available for undelete for the given subscription.
    */
@@ -78,7 +78,7 @@ interface DeletedServicesOperations {
 }
 
 #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "For backward compatibility"
-interface ApiManagementServiceOperations {
+interface ApiManagementServiceOperationGroup {
   /**
    * Checks availability and correctness of a name for an API Management service.
    */
@@ -105,7 +105,7 @@ interface ApiManagementServiceOperations {
 }
 
 #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "For backward compatibility"
-interface ApiManagementSkusOperations {
+interface ApiManagementSkusOperationGroup {
   /**
    * Gets the list of Microsoft.ApiManagement SKUs available for your Subscription.
    */

packages/extensions/openapi-to-typespec/test/arm-authorization/tsp-output/routes.tsp

@@ -14,7 +14,7 @@ using TypeSpec.OpenAPI;
 namespace Azure.ResourceManager.Authorization;
 
 #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "For backward compatibility"
-interface ClassicAdministratorsOperations {
+interface ClassicAdministratorsOperationGroup {
   /**
    * Gets service administrator, account administrator, and co-administrators for the subscription.
    */
@@ -31,7 +31,7 @@ interface ClassicAdministratorsOperations {
 }
 
 #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "For backward compatibility"
-interface GlobalAdministratorOperations {
+interface GlobalAdministratorOperationGroup {
   /**
    * Elevates access for a Global Administrator.
    */
@@ -42,7 +42,7 @@ interface GlobalAdministratorOperations {
 }
 
 #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "For backward compatibility"
-interface AzurePermissionsForResourceGroupOperations {
+interface AzurePermissionsForResourceGroupOperationGroup {
   /**
    * Gets all permissions the caller has for a resource group.
    */
@@ -58,7 +58,7 @@ interface AzurePermissionsForResourceGroupOperations {
 }
 
 #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "For backward compatibility"
-interface AzurePermissionsForResourceOperations {
+interface AzurePermissionsForResourceOperationGroup {
   /**
    * Gets all permissions the caller has for a resource.
    */
@@ -99,7 +99,7 @@ interface AzurePermissionsForResourceOperations {
 }
 
 #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "For backward compatibility"
-interface EligibleChildResourcesOperations {
+interface EligibleChildResourcesOperationGroup {
   /**
    * Get the child resources of a resource on which user has eligible access
    */

packages/extensions/openapi-to-typespec/test/arm-compute/tsp-output/routes.tsp

@@ -14,7 +14,7 @@ using TypeSpec.OpenAPI;
 namespace Microsoft.Compute;
 
 #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "For backward compatibility"
-interface UsageOperations {
+interface UsageOperationGroup {
   /**
    * Gets, for the specified location, the current compute resource usage information as well as the limits for compute resources under the subscription.
    */
@@ -31,7 +31,7 @@ interface UsageOperations {
 }
 
 #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "For backward compatibility"
-interface VirtualMachineSizesOperations {
+interface VirtualMachineSizesOperationGroup {
   /**
    * This API is deprecated. Use [Resources Skus](https://docs.microsoft.com/rest/api/compute/resourceskus/list)
    */
@@ -48,7 +48,7 @@ interface VirtualMachineSizesOperations {
 }
 
 #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "For backward compatibility"
-interface VirtualMachineScaleSetsOperations {
+interface VirtualMachineScaleSetsOperationGroup {
   /**
    * Gets all the VM scale sets under the specified subscription for the specified location.
    */
@@ -65,7 +65,7 @@ interface VirtualMachineScaleSetsOperations {
 }
 
 #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "For backward compatibility"
-interface VirtualMachinesOperations {
+interface VirtualMachinesOperationGroup {
   /**
    * Gets all the virtual machines under the specified subscription for the specified location.
    */
@@ -82,7 +82,7 @@ interface VirtualMachinesOperations {
 }
 
 #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "For backward compatibility"
-interface VirtualMachineImagesOperations {
+interface VirtualMachineImagesOperationGroup {
   /**
    * Gets a virtual machine image.
    */
@@ -268,7 +268,7 @@ interface VirtualMachineImagesOperations {
 }
 
 #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "For backward compatibility"
-interface VirtualMachineImagesEdgeZoneOperations {
+interface VirtualMachineImagesEdgeZoneOperationGroup {
   /**
    * Gets a virtual machine image in an edge zone.
    */
@@ -472,7 +472,7 @@ interface VirtualMachineImagesEdgeZoneOperations {
 }
 
 #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "For backward compatibility"
-interface LogAnalyticsOperations {
+interface LogAnalyticsOperationGroup {
   /**
    * Export logs that show Api requests made by this subscription in the given time window to show throttling activities.
    */
@@ -508,7 +508,7 @@ interface LogAnalyticsOperations {
 }
 
 #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "For backward compatibility"
-interface VirtualMachineRunCommandsOperations {
+interface VirtualMachineRunCommandsOperationGroup {
   /**
    * Lists all available run commands for a subscription in a location.
    */
@@ -550,7 +550,7 @@ interface VirtualMachineRunCommandsOperations {
 }
 
 #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "For backward compatibility"
-interface ResourceSkusOperations {
+interface ResourceSkusOperationGroup {
   /**
    * Gets the list of Microsoft.Compute SKUs available for your Subscription.
    */