Support optional location and lower case etag

common/changes/@autorest/openapi-to-typespec/someUptake_2025-08-13-08-52.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@autorest/openapi-to-typespec",
+      "comment": "Support optional location and lowe case etag",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@autorest/openapi-to-typespec"
+}

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

@@ -228,7 +228,11 @@ export interface Models {
   armResources: TspArmResource[];
 }
 
-export type ArmResourceKind = "TrackedResource" | "ProxyResource" | "ExtensionResource";
+export type ArmResourceKind =
+  | "TrackedResource"
+  | "ProxyResource"
+  | "ExtensionResource"
+  | "Legacy.TrackedResourceWithOptionalLocation";
 export type ArmResourceOperationKind = "TrackedResourceOperations" | "ProxyResourceOperations";
 
 const FIRST_LEVEL_RESOURCE = [

packages/extensions/openapi-to-typespec/src/resource/parse-metadata.ts

@@ -116,8 +116,7 @@ export function parseMetadata(codeModel: CodeModel, configuration: Record<string
             ResourceKey: "",
             ResourceKeySegment: "",
             IsTrackedResource: false,
-            IsTenantResource: false,
-            IsSubscriptionResource: false,
+            IsTrackedResourceWithOptionalLocation: false,
             IsManagementGroupResource: false,
             ScopeType: "NA",
             IsSingletonResource: false,
@@ -168,8 +167,6 @@ function buildResource(
   }
 
   const parents = getParents(set.RequestPath, operationSets);
-  const isTenantResource = parents.length > 0 && parents[0] === "TenantResource";
-  const isSubscriptionResource = parents.length > 0 && parents[0] === "SubscriptionResource";
   const isManagementGroupResource = parents.length > 0 && parents[0] === "ManagementGroupResource";
 
   const operationsFromResourceGroupExtension = [];
@@ -195,6 +192,7 @@ function buildResource(
     }
   }
 
+  const [isStandardTrackedResource, isOptionalLocation] = isTrackedResource(resourceSchema!);
   return {
     Name: lastWordToSingular(resourceSchemaName),
     GetOperation: getOperation,
@@ -213,9 +211,8 @@ function buildResource(
     ResourceType: getResourceType(set.RequestPath),
     ResourceKey: getResourceKey(set.RequestPath),
     ResourceKeySegment: getResourceKeySegment(set.RequestPath),
-    IsTrackedResource: isTrackedResource(resourceSchema!),
-    IsTenantResource: isTenantResource,
-    IsSubscriptionResource: isSubscriptionResource,
+    IsTrackedResource: isStandardTrackedResource,
+    IsTrackedResourceWithOptionalLocation: isStandardTrackedResource && isOptionalLocation,
     IsManagementGroupResource: isManagementGroupResource,
     ScopeType: getExtensionResourceType(set.RequestPath),
     IsSingletonResource: isSingleton(set),

packages/extensions/openapi-to-typespec/src/resource/resource-equivalent.ts

@@ -28,21 +28,23 @@ export function isResource(schema: ObjectSchema): boolean {
   return idPropertyFound && typePropertyFound && namePropertyFound;
 }
 
-export function isTrackedResource(schema: ObjectSchema): boolean {
-  if (!isResource(schema)) return false;
+export function isTrackedResource(schema: ObjectSchema): [isTrackedResource: boolean, isOptionalLocation: boolean] {
+  if (!isResource(schema)) return [false, false];
 
   let isLocationFound = false;
+  let isOptionalLocation = false;
   let isTagsFound = false;
   for (const property of getAllProperties(schema)) {
     if (property.flattenedNames) continue;
 
     if (property.serializedName === "location" && isStringSchema(property.schema)) {
       isLocationFound = true;
+      isOptionalLocation = property.required !== true;
     } else if (property.serializedName === "tags" && isDictionarySchema(property.schema)) {
       isTagsFound = true;
     }
   }
-  return isLocationFound && isTagsFound;
+  return [isLocationFound && isTagsFound, isLocationFound && isTagsFound && isOptionalLocation];
 }
 
 export function getPagingItemType(operation: Operation, markPaging: boolean = false): string | undefined {

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

@@ -955,19 +955,13 @@ function getOtherProperties(
 ): (TypespecObjectProperty | TypespecSpreadStatement)[] {
   const knownProperties = ["properties", "name", "id", "type", "systemData"];
   const resourceKind = getResourceKind(schema);
-  if (resourceKind === "TrackedResource") {
+  if (resourceKind === "TrackedResource" || resourceKind === "Legacy.TrackedResourceWithOptionalLocation") {
     knownProperties.push(...["location", "tags"]);
   }
   const otherProperties: (TypespecObjectProperty | TypespecSpreadStatement)[] = [];
   for (const property of schema.properties ?? []) {
     if (!knownProperties.includes(property.serializedName)) {
       const envolopeProperty = getEnvelopeProperty(property);
-      if (envolopeProperty) {
-        const envelopeAugmentedDecorator = getEnvelopeAugmentedDecorator(schema, property);
-        if (envelopeAugmentedDecorator) {
-          augmentDecorators.push(envelopeAugmentedDecorator);
-        }
-      }
       otherProperties.push(
         envolopeProperty ?? {
           ...transformObjectProperty(property, getSession().model),
@@ -1217,9 +1211,9 @@ function buildOperationParameters(
 
   // By default we don't need any base parameters.
   const parameterTemplate: string[] = [];
-  if (resource.IsTenantResource) {
+  if (resource.ScopeType === "Tenant") {
     parameterTemplate.push(getFullyQualifiedName("TenantBaseParameters"));
-  } else if (resource.IsSubscriptionResource) {
+  } else if (resource.ScopeType === "Subscription") {
     parameterTemplate.push(getFullyQualifiedName("SubscriptionBaseParameters"));
   }
 
@@ -1266,6 +1260,10 @@ function getResourceKind(schema: ArmResourceSchema): ArmResourceKind {
     return "ExtensionResource";
   }
 
+  if (schema.resourceMetadata[0].IsTrackedResourceWithOptionalLocation) {
+    return "Legacy.TrackedResourceWithOptionalLocation";
+  }
+
   if (schema.resourceMetadata[0].IsTrackedResource) {
     return "TrackedResource";
   }
@@ -1359,11 +1357,11 @@ function buildResourceDecorators(schema: ArmResourceSchema): TypespecDecorator[]
     });
   }
 
-  if (schema.resourceMetadata[0].IsTenantResource) {
+  if (schema.resourceMetadata[0].ScopeType === "Tenant") {
     resourceModelDecorators.push({
       name: "tenantResource",
     });
-  } else if (schema.resourceMetadata[0].IsSubscriptionResource) {
+  } else if (schema.resourceMetadata[0].ScopeType === "Subscription") {
     resourceModelDecorators.push({
       name: "subscriptionResource",
     });
@@ -1397,10 +1395,8 @@ function getSingletonName(schema: ArmResourceSchema): string {
 
 function getLocationParent(schema: ArmResourceSchema): string | undefined {
   if (schema.resourceMetadata[0].GetOperation!.Path.includes("/locations/")) {
-    if (schema.resourceMetadata[0].IsTenantResource) {
+    if (schema.resourceMetadata[0].ScopeType === "Tenant") {
       return "TenantLocationResource";
-    } else if (schema.resourceMetadata[0].IsSubscriptionResource) {
-      return "SubscriptionLocationResource";
     } else if (schema.resourceMetadata[0].Parents?.[0] === "ResourceGroupResource") {
       return "ResourceGroupLocationResource";
     }

packages/extensions/openapi-to-typespec/src/utils/envelope-property.ts

@@ -66,13 +66,20 @@ const knownEnvelopes: Record<string, Envelope> = {
     schema: { name: "string", type: "primitive", schema: (schema) => schema.type === "string" },
     envelopeName: "Azure.ResourceManager.EntityTagProperty",
   },
+  etag: {
+    serializedName: "etag",
+    required: false,
+    isReadOnly: true,
+    schema: { name: "string", type: "primitive", schema: (schema) => schema.type === "string" },
+    envelopeName: "Azure.ResourceManager.Legacy.EntityTagProperty",
+  },
 };
 
 export function getEnvelopeProperty(property: Property): TypespecSpreadStatement | undefined {
   for (const key of Object.keys(knownEnvelopes)) {
     const envelope = knownEnvelopes[key];
     if (
-      property.serializedName.toLowerCase() === envelope.serializedName.toLowerCase() &&
+      property.serializedName === envelope.serializedName &&
       (property.required ?? false) === envelope.required &&
       (property.readOnly ?? false) === envelope.isReadOnly &&
       isEquivalent(property.schema, envelope.schema)

packages/extensions/openapi-to-typespec/src/utils/resource-discovery.ts

@@ -43,8 +43,7 @@ export interface ArmResource {
   ResourceKey: string;
   ResourceKeySegment: string;
   IsTrackedResource: boolean;
-  IsTenantResource: boolean;
-  IsSubscriptionResource: boolean;
+  IsTrackedResourceWithOptionalLocation: boolean;
   IsManagementGroupResource: boolean;
   ScopeType: ScopeType;
   IsSingletonResource: boolean;

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

@@ -67,8 +67,7 @@
         "ResourceKey": "dataConnectorName",
         "ResourceKeySegment": "dataConnectors",
         "IsTrackedResource": false,
-        "IsTenantResource": false,
-        "IsSubscriptionResource": false,
+        "IsTrackedResourceWithOptionalLocation": false,
         "IsManagementGroupResource": false,
         "ScopeType": "ResourceGroup",
         "IsSingletonResource": false
@@ -114,8 +113,7 @@
         "ResourceKey": "dataManagerForAgricultureExtensionId",
         "ResourceKeySegment": "farmBeatsExtensionDefinitions",
         "IsTrackedResource": false,
-        "IsTenantResource": true,
-        "IsSubscriptionResource": false,
+        "IsTrackedResourceWithOptionalLocation": false,
         "IsManagementGroupResource": false,
         "ScopeType": "Tenant",
         "IsSingletonResource": false
@@ -202,8 +200,7 @@
         "ResourceKey": "dataManagerForAgricultureResourceName",
         "ResourceKeySegment": "farmBeats",
         "IsTrackedResource": true,
-        "IsTenantResource": false,
-        "IsSubscriptionResource": false,
+        "IsTrackedResourceWithOptionalLocation": false,
         "IsManagementGroupResource": false,
         "ScopeType": "ResourceGroup",
         "IsSingletonResource": false
@@ -276,8 +273,7 @@
         "ResourceKey": "extensionId",
         "ResourceKeySegment": "extensions",
         "IsTrackedResource": false,
-        "IsTenantResource": false,
-        "IsSubscriptionResource": false,
+        "IsTrackedResourceWithOptionalLocation": false,
         "IsManagementGroupResource": false,
         "ScopeType": "ResourceGroup",
         "IsSingletonResource": false
@@ -350,8 +346,7 @@
         "ResourceKey": "privateEndpointConnectionName",
         "ResourceKeySegment": "privateEndpointConnections",
         "IsTrackedResource": false,
-        "IsTenantResource": false,
-        "IsSubscriptionResource": false,
+        "IsTrackedResourceWithOptionalLocation": false,
         "IsManagementGroupResource": false,
         "ScopeType": "ResourceGroup",
         "IsSingletonResource": false
@@ -397,8 +392,7 @@
         "ResourceKey": "subResourceName",
         "ResourceKeySegment": "privateLinkResources",
         "IsTrackedResource": false,
-        "IsTenantResource": false,
-        "IsSubscriptionResource": false,
+        "IsTrackedResourceWithOptionalLocation": false,
         "IsManagementGroupResource": false,
         "ScopeType": "ResourceGroup",
         "IsSingletonResource": false
@@ -471,8 +465,7 @@
         "ResourceKey": "solutionId",
         "ResourceKeySegment": "solutions",
         "IsTrackedResource": false,
-        "IsTenantResource": false,
-        "IsSubscriptionResource": false,
+        "IsTrackedResourceWithOptionalLocation": false,
         "IsManagementGroupResource": false,
         "ScopeType": "ResourceGroup",
         "IsSingletonResource": false
@@ -518,8 +511,7 @@
         "ResourceKey": "dataManagerForAgricultureSolutionId",
         "ResourceKeySegment": "farmBeatsSolutionDefinitions",
         "IsTrackedResource": false,
-        "IsTenantResource": true,
-        "IsSubscriptionResource": false,
+        "IsTrackedResourceWithOptionalLocation": false,
         "IsManagementGroupResource": false,
         "ScopeType": "Tenant",
         "IsSingletonResource": false

packages/extensions/openapi-to-typespec/test/arm-alertsmanagement/resources.json

@@ -81,8 +81,7 @@
         "ResourceKey": "alertProcessingRuleName",
         "ResourceKeySegment": "actionRules",
         "IsTrackedResource": true,
-        "IsTenantResource": false,
-        "IsSubscriptionResource": false,
+        "IsTrackedResourceWithOptionalLocation": false,
         "IsManagementGroupResource": false,
         "ScopeType": "ResourceGroup",
         "IsSingletonResource": false
@@ -147,8 +146,7 @@
         "ResourceKey": "alertId",
         "ResourceKeySegment": "alerts",
         "IsTrackedResource": false,
-        "IsTenantResource": false,
-        "IsSubscriptionResource": true,
+        "IsTrackedResourceWithOptionalLocation": false,
         "IsManagementGroupResource": false,
         "ScopeType": "Subscription",
         "IsSingletonResource": false
@@ -213,8 +211,7 @@
         "ResourceKey": "smartGroupId",
         "ResourceKeySegment": "smartGroups",
         "IsTrackedResource": false,
-        "IsTenantResource": false,
-        "IsSubscriptionResource": true,
+        "IsTrackedResourceWithOptionalLocation": false,
         "IsManagementGroupResource": false,
         "ScopeType": "Subscription",
         "IsSingletonResource": false

packages/extensions/openapi-to-typespec/test/arm-analysisservices/resources.json

@@ -131,8 +131,7 @@
         "ResourceKey": "serverName",
         "ResourceKeySegment": "servers",
         "IsTrackedResource": true,
-        "IsTenantResource": false,
-        "IsSubscriptionResource": false,
+        "IsTrackedResourceWithOptionalLocation": false,
         "IsManagementGroupResource": false,
         "ScopeType": "ResourceGroup",
         "IsSingletonResource": false