Add comparisons for model schema

Azure · Jun 27, 2024 · cec9604 · cec9604
1 parent ff77297
commit cec9604
Show file tree

Hide file tree

Showing 11 changed files with 182 additions and 14 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -144,6 +144,26 @@
         "order": 2
       }
     },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Compile AllProps",
+      "program": "${workspaceRoot}/core/packages/compiler/entrypoints/cli.js",
+      "args": ["compile", ".", "--emit=@azure-tools/typespec-autorest"],
+      "smartStep": true,
+      "sourceMaps": true,
+      "skipFiles": ["<node_internals>/**/*.js"],
+      "outFiles": [
+        "${workspaceFolder}/packages/*/dist/**/*.js",
+        "${workspaceFolder}/packages/*/dist-dev/**/*.js",
+        "${workspaceFolder}/core/packages/*/dist/**/*.js",
+        "${workspaceFolder}/core/packages/*/dist-dev/**/*.js"
+      ],
+      "cwd": "${workspaceRoot}/packages/samples/specs/resource-manager/arm-library",
+      "presentation": {
+        "order": 2
+      }
+    },
     {
       "name": "Regenerate .tmlanguage",
       "type": "node",

diff --git a/...est/output/azure/resource-manager/arm-library/@azure-tools/typespec-autorest/openapi.json b/...est/output/azure/resource-manager/arm-library/@azure-tools/typespec-autorest/openapi.json
@@ -1907,6 +1907,24 @@
         }
       }
     },
+    "Azure.ResourceManager.CommonTypes.TrackedResourceUpdate": {
+      "type": "object",
+      "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'",
+      "properties": {
+        "tags": {
+          "type": "object",
+          "description": "Resource tags.",
+          "additionalProperties": {
+            "type": "string"
+          }
+        }
+      },
+      "allOf": [
+        {
+          "$ref": "../../../../../../../specs/resource-manager/common-types/v5/types.json#/definitions/Resource"
+        }
+      ]
+    },
     "Azure.ResourceManager.ResourceProvisioningState": {
       "type": "string",
       "description": "The provisioning state of a resource type.",
@@ -2116,7 +2134,7 @@
       },
       "allOf": [
         {
-          "$ref": "../../../../../../../specs/resource-manager/common-types/v5/types.json#/definitions/TrackedResource"
+          "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.TrackedResourceUpdate"
         }
       ]
     },

diff --git a/...r/operations/nobody-action/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json b/...r/operations/nobody-action/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json
@@ -581,6 +581,24 @@
     }
   },
   "definitions": {
+    "Azure.ResourceManager.CommonTypes.TrackedResourceUpdate": {
+      "type": "object",
+      "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'",
+      "properties": {
+        "tags": {
+          "type": "object",
+          "description": "Resource tags.",
+          "additionalProperties": {
+            "type": "string"
+          }
+        }
+      },
+      "allOf": [
+        {
+          "$ref": "../../../../../../../../../specs/resource-manager/common-types/v5/types.json#/definitions/Resource"
+        }
+      ]
+    },
     "Employee": {
       "type": "object",
       "description": "A ContosoProviderHub resource",
@@ -655,7 +673,7 @@
       },
       "allOf": [
         {
-          "$ref": "../../../../../../../../../specs/resource-manager/common-types/v5/types.json#/definitions/TrackedResource"
+          "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.TrackedResourceUpdate"
         }
       ]
     },

diff --git a/...er/resource-types/location/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json b/...er/resource-types/location/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json
@@ -430,6 +430,24 @@
     }
   },
   "definitions": {
+    "Azure.ResourceManager.CommonTypes.TrackedResourceUpdate": {
+      "type": "object",
+      "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'",
+      "properties": {
+        "tags": {
+          "type": "object",
+          "description": "Resource tags.",
+          "additionalProperties": {
+            "type": "string"
+          }
+        }
+      },
+      "allOf": [
+        {
+          "$ref": "../../../../../../../../../specs/resource-manager/common-types/v5/types.json#/definitions/Resource"
+        }
+      ]
+    },
     "Employee": {
       "type": "object",
       "description": "A ContosoProviderHub resource",
@@ -504,7 +522,7 @@
       },
       "allOf": [
         {
-          "$ref": "../../../../../../../../../specs/resource-manager/common-types/v5/types.json#/definitions/TrackedResource"
+          "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.TrackedResourceUpdate"
         }
       ]
     },

diff --git a/...nager/resource-types/proxy/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json b/...nager/resource-types/proxy/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json
@@ -724,6 +724,24 @@
     }
   },
   "definitions": {
+    "Azure.ResourceManager.CommonTypes.TrackedResourceUpdate": {
+      "type": "object",
+      "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'",
+      "properties": {
+        "tags": {
+          "type": "object",
+          "description": "Resource tags.",
+          "additionalProperties": {
+            "type": "string"
+          }
+        }
+      },
+      "allOf": [
+        {
+          "$ref": "../../../../../../../../../specs/resource-manager/common-types/v5/types.json#/definitions/Resource"
+        }
+      ]
+    },
     "Dependent": {
       "type": "object",
       "description": "Concrete proxy resource types can be created by aliasing this type using a specific property type.",
@@ -890,7 +908,7 @@
       },
       "allOf": [
         {
-          "$ref": "../../../../../../../../../specs/resource-manager/common-types/v5/types.json#/definitions/TrackedResource"
+          "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.TrackedResourceUpdate"
         }
       ]
     },

diff --git a/...r/resource-types/singleton/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json b/...r/resource-types/singleton/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json
@@ -329,6 +329,24 @@
     }
   },
   "definitions": {
+    "Azure.ResourceManager.CommonTypes.TrackedResourceUpdate": {
+      "type": "object",
+      "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'",
+      "properties": {
+        "tags": {
+          "type": "object",
+          "description": "Resource tags.",
+          "additionalProperties": {
+            "type": "string"
+          }
+        }
+      },
+      "allOf": [
+        {
+          "$ref": "../../../../../../../../../specs/resource-manager/common-types/v5/types.json#/definitions/Resource"
+        }
+      ]
+    },
     "Employee": {
       "type": "object",
       "description": "A ContosoProviderHub resource",
@@ -403,7 +421,7 @@
       },
       "allOf": [
         {
-          "$ref": "../../../../../../../../../specs/resource-manager/common-types/v5/types.json#/definitions/TrackedResource"
+          "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.TrackedResourceUpdate"
         }
       ]
     },

diff --git a/...ager/resource-types/tenant/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json b/...ager/resource-types/tenant/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json
@@ -367,6 +367,24 @@
     }
   },
   "definitions": {
+    "Azure.ResourceManager.CommonTypes.TrackedResourceUpdate": {
+      "type": "object",
+      "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'",
+      "properties": {
+        "tags": {
+          "type": "object",
+          "description": "Resource tags.",
+          "additionalProperties": {
+            "type": "string"
+          }
+        }
+      },
+      "allOf": [
+        {
+          "$ref": "../../../../../../../../../specs/resource-manager/common-types/v5/types.json#/definitions/Resource"
+        }
+      ]
+    },
     "Employee": {
       "type": "object",
       "description": "A ContosoProviderHub resource",
@@ -441,7 +459,7 @@
       },
       "allOf": [
         {
-          "$ref": "../../../../../../../../../specs/resource-manager/common-types/v5/types.json#/definitions/TrackedResource"
+          "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.TrackedResourceUpdate"
         }
       ]
     },

diff --git a/...ger/resource-types/tracked/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json b/...ger/resource-types/tracked/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json
@@ -443,6 +443,24 @@
     }
   },
   "definitions": {
+    "Azure.ResourceManager.CommonTypes.TrackedResourceUpdate": {
+      "type": "object",
+      "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'",
+      "properties": {
+        "tags": {
+          "type": "object",
+          "description": "Resource tags.",
+          "additionalProperties": {
+            "type": "string"
+          }
+        }
+      },
+      "allOf": [
+        {
+          "$ref": "../../../../../../../../../specs/resource-manager/common-types/v5/types.json#/definitions/Resource"
+        }
+      ]
+    },
     "Employee": {
       "type": "object",
       "description": "A ContosoProviderHub resource",
@@ -517,7 +535,7 @@
       },
       "allOf": [
         {
-          "$ref": "../../../../../../../../../specs/resource-manager/common-types/v5/types.json#/definitions/TrackedResource"
+          "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.TrackedResourceUpdate"
         }
       ]
     },

diff --git a/...rce-types/virtual-resource/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json b/...rce-types/virtual-resource/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json
@@ -521,6 +521,24 @@
     }
   },
   "definitions": {
+    "Azure.ResourceManager.CommonTypes.TrackedResourceUpdate": {
+      "type": "object",
+      "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'",
+      "properties": {
+        "tags": {
+          "type": "object",
+          "description": "Resource tags.",
+          "additionalProperties": {
+            "type": "string"
+          }
+        }
+      },
+      "allOf": [
+        {
+          "$ref": "../../../../../../../../../specs/resource-manager/common-types/v5/types.json#/definitions/Resource"
+        }
+      ]
+    },
     "Division": {
       "type": "object",
       "description": "The company division",
@@ -609,7 +627,7 @@
       },
       "allOf": [
         {
-          "$ref": "../../../../../../../../../specs/resource-manager/common-types/v5/types.json#/definitions/TrackedResource"
+          "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.TrackedResourceUpdate"
         }
       ]
     },

diff --git a/packages/typespec-autorest/src/openapi.ts b/packages/typespec-autorest/src/openapi.ts
@@ -879,12 +879,12 @@ export async function getOpenAPIForService(
     }
     return undefined;
   }
-  function getSchemaOrRef(type: Type, schemaContext: SchemaContext, isDerived?: boolean): any {
+  function getSchemaOrRef(type: Type, schemaContext: SchemaContext): any {
     let schemaNameOverride: ((name: string, visibility: Visibility) => string) | undefined =
       undefined;
     const ref = resolveExternalRef(type);
     if (ref) {
-      if (isDerived || !metadataInfo.isTransformed(type, schemaContext.visibility)) {
+      if (!metadataInfo.isTransformed(type, schemaContext.visibility)) {
         return ref;
       }
 
@@ -1653,6 +1653,7 @@ export async function getOpenAPIForService(
 
   function includeDerivedModel(model: Model): boolean {
     return (
+      !resolveExternalRef(model) &&
       !isTemplateDeclaration(model) &&
       (model.templateMapper?.args === undefined ||
         model.templateMapper?.args.length === 0 ||
@@ -1710,11 +1711,13 @@ export async function getOpenAPIForService(
       modelSchema.additionalProperties = getSchemaOrRef(model.indexer.value, schemaContext);
     }
 
-    const derivedModels = model.derivedModels.filter(includeDerivedModel);
+    const derivedModels = resolveExternalRef(model)
+      ? []
+      : model.derivedModels.filter(includeDerivedModel);
 
     // getSchemaOrRef on all children to push them into components.schemas
     for (const child of derivedModels) {
-      getSchemaOrRef(child, schemaContext, true);
+      getSchemaOrRef(child, schemaContext);
     }
 
     const discriminator = getDiscriminator(program, model);

diff --git a/packages/typespec-azure-resource-manager/lib/interfaces.tsp b/packages/typespec-azure-resource-manager/lib/interfaces.tsp
@@ -120,7 +120,7 @@ interface ResourceInstanceOperations<
   Resource extends Foundations.Resource,
   Properties extends TypeSpec.Reflection.Model,
   BaseParameters = DefaultBaseParameters<Resource>,
-  PatchModel = ResourceUpdateModel<Resource, Properties>
+  PatchModel extends {} = {}
 >
   extends ResourceRead<Resource, BaseParameters>,
     ResourceCreate<Resource, BaseParameters>,
@@ -314,7 +314,8 @@ interface ResourceUpdateAsync<
 interface ResourceUpdateSync<
   Resource extends Foundations.Resource,
   Properties extends TypeSpec.Reflection.Model,
-  BaseParameters = DefaultBaseParameters<Resource>
+  BaseParameters = DefaultBaseParameters<Resource>,
+  PatchModel extends {} = {}
 > {
   /**
    * @dev Update a resource using the synchronous call pattern.