File structure change for brownfield services (#5098)

Co-authored-by: Pan Shao <pashao@microsoft.com>

Author: pshao25

common/changes/@autorest/openapi-to-typespec/fileFix_2025-04-18-09-25.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@autorest/openapi-to-typespec",
+      "comment": "File structure for brownfield services",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@autorest/openapi-to-typespec"
+}

packages/extensions/openapi-to-typespec/src/emiters/emit-client.ts

@@ -21,10 +21,12 @@ export async function emitClient(filePath: string, program: TypespecProgram): Pr
 }
 
 function generateClient(program: TypespecProgram) {
-  const { isArm } = getOptions();
+  const { isArm, isFullCompatible } = getOptions();
   const { models } = program;
   const { modules, namespaces: namespacesSet } = getClientImports(program);
-  const imports = [...new Set<string>([`import "./main.tsp";`, ...modules])].join("\n");
+  const imports = (
+    isFullCompatible ? [...new Set<string>([...modules])] : [...new Set<string>([`import "./main.tsp";`, ...modules])]
+  ).join("\n");
 
   const namespaces = [...new Set<string>([...namespacesSet, `using ${getNamespace(program)};`])].join("\n");
   const objects = models.objects

packages/extensions/openapi-to-typespec/src/emiters/emit-main.ts

@@ -62,21 +62,29 @@ function getServiceInformation(program: TypespecProgram) {
 }
 
 function getArmServiceInformation(program: TypespecProgram, metadata: Metadata) {
+  const { isFullCompatible } = getOptions();
   const imports = [
     `import "@typespec/rest";`,
     `import "@typespec/versioning";`,
     `import "@azure-tools/typespec-azure-core";`,
     `import "@azure-tools/typespec-azure-resource-manager";`,
     `import "./models.tsp";`,
-    ...getArmResourceImports(program, metadata),
-    ``,
-    `using TypeSpec.Rest;`,
-    `using TypeSpec.Http;`,
-    `using Azure.ResourceManager.Foundations;`,
-    `using Azure.Core;`,
-    `using Azure.ResourceManager;`,
-    `using TypeSpec.Versioning;`,
   ];
+  if (isFullCompatible) {
+    imports.push(`import "./back-compatible.tsp";`);
+  }
+  imports.push(
+    ...[
+      ...getArmResourceImports(program, metadata),
+      ``,
+      `using TypeSpec.Rest;`,
+      `using TypeSpec.Http;`,
+      `using Azure.ResourceManager.Foundations;`,
+      `using Azure.Core;`,
+      `using Azure.ResourceManager;`,
+      `using TypeSpec.Versioning;`,
+    ],
+  );
   const content = generateServiceInformation(program);
 
   return [...imports, content].join("\n");

packages/extensions/openapi-to-typespec/src/emiters/emit-typespec-config.ts

@@ -38,7 +38,6 @@ export async function emitTypespecConfig(filePath: string, programDetails: Types
   - '@azure-tools/typespec-autorest'
 options:
   '@azure-tools/typespec-autorest':
-    use-read-only-status-schema: true
     omit-unreachable-types: true
     emitter-output-dir: "{project-root}/.."
     azure-resource-provider-folder: "resource-manager"

packages/extensions/openapi-to-typespec/src/generate/generate-client.ts

@@ -43,12 +43,7 @@ export function generateArmResourceClientDecorator(resource: TspArmResource): st
   const definitions: string[] = [];
 
   const formalOperationGroupName = pluralize(resource.name);
-  let targetName = formalOperationGroupName;
-
-  if (resource.name === formalOperationGroupName) {
-    targetName = `${formalOperationGroupName}OperationGroup}`;
-    definitions.push(`@@clientName(${formalOperationGroupName}OperationGroup, "${formalOperationGroupName}")`);
-  }
+  const targetName = formalOperationGroupName;
 
   if (resource.clientDecorators && resource.clientDecorators.length > 0)
     definitions.push(generateAugmentedDecorators(resource.name, resource.clientDecorators));

packages/extensions/openapi-to-typespec/src/main.ts

@@ -32,7 +32,7 @@ export async function processConverter(host: AutorestExtensionHost) {
   setSession(session);
   const codeModel = session.model;
   pretransformNames(codeModel);
-  const { isArm } = getOptions();
+  const { isArm, isFullCompatible } = getOptions();
   let metadata: Metadata | undefined = undefined;
   if (isArm) {
     // await host.writeFile({ filename: "codeModel.yaml", content: serialize(codeModel, codeModelSchema) });
@@ -55,7 +55,7 @@ export async function processConverter(host: AutorestExtensionHost) {
   await emitMain(programDetails, metadata, getOutuptDirectory(session));
   await emitPackage(getFilePath(session, "package.json"), programDetails);
   await emitTypespecConfig(getFilePath(session, "tspconfig.yaml"), programDetails);
-  await emitClient(getFilePath(session, "client.tsp"), programDetails);
+  await emitClient(getFilePath(session, isFullCompatible ? "back-compatible.tsp" : "client.tsp"), programDetails);
   if (metadata && Object.keys(metadata.Resources).find((key) => metadata!.Resources[key].length > 1)) {
     await emitLegacy(getFilePath(session, "legacy.tsp"));
   }

packages/extensions/openapi-to-typespec/test/arm-agrifood/swagger-output/swagger.json

@@ -630,7 +630,7 @@
             "pattern": "^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$"
           },
           {
-            "name": "resource",
+            "name": "request",
             "in": "body",
             "description": "Data Manager For Agriculture resource create or update request object.",
             "required": true,
@@ -692,7 +692,7 @@
             "pattern": "^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$"
           },
           {
-            "name": "properties",
+            "name": "request",
             "in": "body",
             "description": "Request object.",
             "required": true,
@@ -953,7 +953,7 @@
             "maxLength": 63
           },
           {
-            "name": "resource",
+            "name": "body",
             "in": "body",
             "description": "Body must be valid DataConnector request.",
             "required": true,
@@ -1226,7 +1226,7 @@
             "type": "string"
           },
           {
-            "name": "resource",
+            "name": "requestBody",
             "in": "body",
             "description": "Extension resource request body.",
             "required": true,
@@ -1448,7 +1448,7 @@
             "type": "string"
           },
           {
-            "name": "resource",
+            "name": "request",
             "in": "body",
             "description": "Request object.",
             "required": true,
@@ -1903,7 +1903,7 @@
             "pattern": "^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$"
           },
           {
-            "name": "resource",
+            "name": "requestBody",
             "in": "body",
             "description": "Solution resource request body.",
             "required": true,
@@ -2259,7 +2259,8 @@
         },
         "$skipToken": {
           "type": "string",
-          "description": "Token used in retrieving the next page. If null, there are no additional pages."
+          "description": "Token used in retrieving the next page. If null, there are no additional pages.",
+          "x-ms-client-name": "skipToken"
         }
       },
       "required": [
@@ -2358,7 +2359,8 @@
         },
         "$skipToken": {
           "type": "string",
-          "description": "Token used in retrieving the next page. If null, there are no additional pages."
+          "description": "Token used in retrieving the next page. If null, there are no additional pages.",
+          "x-ms-client-name": "skipToken"
         }
       },
       "required": [
@@ -2432,7 +2434,8 @@
         },
         "$skipToken": {
           "type": "string",
-          "description": "Token used in retrieving the next page. If null, there are no additional pages."
+          "description": "Token used in retrieving the next page. If null, there are no additional pages.",
+          "x-ms-client-name": "skipToken"
         }
       },
       "required": [
@@ -2634,7 +2637,8 @@
         },
         "$skipToken": {
           "type": "string",
-          "description": "Token used in retrieving the next page. If null, there are no additional pages."
+          "description": "Token used in retrieving the next page. If null, there are no additional pages.",
+          "x-ms-client-name": "skipToken"
         }
       },
       "required": [
@@ -2872,8 +2876,7 @@
             "value": "Failed"
           }
         ]
-      },
-      "readOnly": true
+      }
     },
     "PrivateEndpointServiceConnectionStatus": {
       "type": "string",
@@ -3015,8 +3018,7 @@
             "value": "Running"
           }
         ]
-      },
-      "readOnly": true
+      }
     },
     "PublicNetworkAccess": {
       "type": "string",
@@ -3098,7 +3100,8 @@
         },
         "$skipToken": {
           "type": "string",
-          "description": "Token used in retrieving the next page. If null, there are no additional pages."
+          "description": "Token used in retrieving the next page. If null, there are no additional pages.",
+          "x-ms-client-name": "skipToken"
         }
       },
       "required": [

…/test/arm-agrifood/tsp-output/client.tsp …-agrifood/tsp-output/back-compatible.tsppackages/extensions/openapi-to-typespec/test/arm-agrifood/tsp-output/client.tsp renamed to packages/extensions/openapi-to-typespec/test/arm-agrifood/tsp-output/back-compatible.tsp packages/extensions/openapi-to-typespec/test/arm-agrifood/tsp-output/client.tsp renamed to packages/extensions/openapi-to-typespec/test/arm-agrifood/tsp-output/back-compatible.tsp

@@ -1,4 +1,3 @@
-import "./main.tsp";
 import "@azure-tools/typespec-client-generator-core";
 
 using Azure.ClientGenerator.Core;

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

@@ -12,6 +12,7 @@ import "@typespec/versioning";
 import "@azure-tools/typespec-azure-core";
 import "@azure-tools/typespec-azure-resource-manager";
 import "./models.tsp";
+import "./back-compatible.tsp";
 import "./DataConnector.tsp";
 import "./DataManagerForAgricultureExtension.tsp";
 import "./DataManagerForAgriculture.tsp";

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

@@ -2,7 +2,6 @@ emit:
   - "@azure-tools/typespec-autorest"
 options:
   "@azure-tools/typespec-autorest":
-    use-read-only-status-schema: true
     omit-unreachable-types: true
     emitter-output-dir: "{project-root}/.."
     azure-resource-provider-folder: "resource-manager"