Allow @armCommonDefinition decorator to be used on enums and unions (…

…#1116) fix #995
Azure · Jul 11, 2024 · fcebc28 · fcebc28
1 parent a19f094
commit fcebc28
Show file tree

Hide file tree

Showing 9 changed files with 98 additions and 9 deletions.
diff --git a/.chronus/changes/arm-common-def-enum-union-2024-6-2-19-28-7.md b/.chronus/changes/arm-common-def-enum-union-2024-6-2-19-28-7.md
@@ -0,0 +1,8 @@
+---
+# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking
+changeKind: feature
+packages:
+  - "@azure-tools/typespec-azure-resource-manager"
+---
+
+Link CommonTypes enums and unions to the swagger common types
diff --git a/.chronus/changes/arm-common-def-enum-union-2024-6-2-20-54-54.md b/.chronus/changes/arm-common-def-enum-union-2024-6-2-20-54-54.md
@@ -0,0 +1,8 @@
+---
+# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking
+changeKind: feature
+packages:
+  - "@azure-tools/typespec-autorest"
+---
+
+Resolve Arm Common Definitions for enums and unions as well
diff --git a/packages/typespec-autorest/src/openapi.ts b/packages/typespec-autorest/src/openapi.ts
@@ -865,7 +865,13 @@ export async function getOpenAPIForService(
       };
     }
 
-    if (isArmCommonType(type) && (type.kind === "Model" || type.kind === "ModelProperty")) {
+    if (
+      isArmCommonType(type) &&
+      (type.kind === "Model" ||
+        type.kind === "ModelProperty" ||
+        type.kind === "Enum" ||
+        type.kind === "Union")
+    ) {
       const ref = getArmCommonTypeOpenAPIRef(program, type, {
         version: context.version,
         service: context.service,

diff --git a/packages/typespec-azure-resource-manager/lib/common-types/commontypes.private.decorators.tsp b/packages/typespec-azure-resource-manager/lib/common-types/commontypes.private.decorators.tsp
@@ -19,7 +19,7 @@ alias ArmCommonTypeVersionSpec = {
  * @param referenceFile Reference file
  */
 extern dec armCommonDefinition(
-  target: Model,
+  target: Model | Enum | Union,
   definitionName?: valueof string,
   version?: valueof EnumMember | ArmCommonTypeVersionSpec | string,
   referenceFile?: valueof string

diff --git a/packages/typespec-azure-resource-manager/lib/common-types/managed-identity-ref.tsp b/packages/typespec-azure-resource-manager/lib/common-types/managed-identity-ref.tsp
@@ -77,3 +77,34 @@ namespace Azure.ResourceManager.CommonTypes;
   Azure.ResourceManager.CommonTypes.Versions.v5,
   "managedidentity.json"
 );
+
+@@armCommonDefinition(ManagedServiceIdentityType,
+  "ManagedServiceIdentityType",
+  Azure.ResourceManager.CommonTypes.Versions.v3,
+  "managedidentity.json"
+);
+@@armCommonDefinition(ManagedServiceIdentityType,
+  "ManagedServiceIdentityType",
+  Azure.ResourceManager.CommonTypes.Versions.v4,
+  "managedidentity.json"
+);
+@@armCommonDefinition(ManagedServiceIdentityType,
+  "ManagedServiceIdentityType",
+  Azure.ResourceManager.CommonTypes.Versions.v5,
+  "managedidentity.json"
+);
+@@armCommonDefinition(SystemAssignedServiceIdentityType,
+  "SystemAssignedServiceIdentityType",
+  Azure.ResourceManager.CommonTypes.Versions.v3,
+  "managedidentity.json"
+);
+@@armCommonDefinition(SystemAssignedServiceIdentityType,
+  "SystemAssignedServiceIdentityType",
+  Azure.ResourceManager.CommonTypes.Versions.v4,
+  "managedidentity.json"
+);
+@@armCommonDefinition(SystemAssignedServiceIdentityType,
+  "SystemAssignedServiceIdentityType",
+  Azure.ResourceManager.CommonTypes.Versions.v5,
+  "managedidentity.json"
+);
diff --git a/packages/typespec-azure-resource-manager/lib/common-types/private-links-ref.tsp b/packages/typespec-azure-resource-manager/lib/common-types/private-links-ref.tsp
@@ -144,6 +144,36 @@ namespace Azure.ResourceManager.CommonTypes;
   "privatelinks.json"
 );
 
+// PrivateEndpointServiceConnectionStatus
+@@armCommonDefinition(PrivateEndpointServiceConnectionStatus,
+  "PrivateEndpointServiceConnectionStatus",
+  Azure.ResourceManager.CommonTypes.Versions.v3,
+  "privatelinks.json"
+);
+@@armCommonDefinition(PrivateEndpointServiceConnectionStatus,
+  "PrivateEndpointServiceConnectionStatus",
+  Azure.ResourceManager.CommonTypes.Versions.v4
+);
+@@armCommonDefinition(PrivateEndpointServiceConnectionStatus,
+  "PrivateEndpointServiceConnectionStatus",
+  Azure.ResourceManager.CommonTypes.Versions.v5
+);
+
+// PrivateEndpointServiceConnectionStatus
+@@armCommonDefinition(PrivateEndpointConnectionProvisioningState,
+  "PrivateEndpointConnectionProvisioningState",
+  Azure.ResourceManager.CommonTypes.Versions.v3,
+  "privatelinks.json"
+);
+@@armCommonDefinition(PrivateEndpointConnectionProvisioningState,
+  "PrivateEndpointConnectionProvisioningState",
+  Azure.ResourceManager.CommonTypes.Versions.v4
+);
+@@armCommonDefinition(PrivateEndpointConnectionProvisioningState,
+  "PrivateEndpointConnectionProvisioningState",
+  Azure.ResourceManager.CommonTypes.Versions.v5
+);
+
 /** PrivateEndpointConnectionParameter */
 @@CommonTypes.Private.armCommonParameter(PrivateEndpointConnectionParameter.name,
   "PrivateEndpointConnectionName",

diff --git a/packages/typespec-azure-resource-manager/lib/common-types/types-ref.tsp b/packages/typespec-azure-resource-manager/lib/common-types/types-ref.tsp
@@ -283,6 +283,10 @@ namespace Azure.ResourceManager.CommonTypes;
   Azure.ResourceManager.CommonTypes.Versions.v5
 );
 
+@@armCommonDefinition(SkuTier, "SkuTier", Azure.ResourceManager.CommonTypes.Versions.v3);
+@@armCommonDefinition(SkuTier, "SkuTier", Azure.ResourceManager.CommonTypes.Versions.v4);
+@@armCommonDefinition(SkuTier, "SkuTier", Azure.ResourceManager.CommonTypes.Versions.v5);
+
 // -- Parameters
 /** ApiVersionParameter */
 @@armCommonParameter(ApiVersionParameter.apiVersion,

diff --git a/packages/typespec-azure-resource-manager/src/common-types.ts b/packages/typespec-azure-resource-manager/src/common-types.ts
@@ -10,6 +10,7 @@ import {
   Program,
   Service,
   Type,
+  Union,
   isTypeSpecValueTypeOf,
 } from "@typespec/compiler";
 import { $useDependency, getVersion } from "@typespec/versioning";
@@ -69,7 +70,7 @@ export function getArmCommonTypesVersionFromString(
  */
 export function isArmCommonType(entity: Type): boolean {
   const commonDecorators = ["$armCommonDefinition", "$armCommonParameter"];
-  if (isTypeSpecValueTypeOf(entity, ["Model", "ModelProperty"])) {
+  if (isTypeSpecValueTypeOf(entity, ["Model", "ModelProperty", "Enum", "Union"])) {
     return commonDecorators.some((commonDecorator) =>
       entity.decorators.some((d) => d.decorator.name === commonDecorator)
     );
@@ -134,7 +135,7 @@ export function getArmCommonTypesVersion(
  */
 export function getArmCommonTypeOpenAPIRef(
   program: Program,
-  entity: Model | ModelProperty,
+  entity: Model | ModelProperty | Enum | Union,
   params: ArmCommonTypesResolutionOptions
 ): string | undefined {
   const [record, diagnostics] = findArmCommonTypeRecord(program, entity, params);
@@ -161,7 +162,7 @@ export interface ArmCommonTypesResolutionOptions {
 
 export function findArmCommonTypeRecord(
   program: Program,
-  entity: Model | ModelProperty,
+  entity: Model | ModelProperty | Enum | Union,
   params: ArmCommonTypesResolutionOptions
 ): [ArmCommonTypeRecord | undefined, readonly Diagnostic[]] {
   const { records, defaultKey } = getCommonTypeRecords(program, entity);

diff --git a/packages/typespec-azure-resource-manager/src/commontypes.private.decorators.ts b/packages/typespec-azure-resource-manager/src/commontypes.private.decorators.ts
@@ -5,6 +5,7 @@ import {
   Model,
   ModelProperty,
   Program,
+  Union,
 } from "@typespec/compiler";
 import { ArmStateKeys } from "./state.js";
 
@@ -18,7 +19,7 @@ function getArmTypesPath(program: Program): string {
 
 function storeCommonTypeRecord(
   context: DecoratorContext,
-  entity: Model | ModelProperty,
+  entity: Model | ModelProperty | Enum | Union,
   kind: "definitions" | "parameters",
   name: string,
   version?: string | EnumValue | ArmCommonTypeVersionSpec,
@@ -69,7 +70,7 @@ export interface ArmCommonTypeRecords {
 
 export function getCommonTypeRecords(
   program: Program,
-  entity: Model | ModelProperty
+  entity: Model | ModelProperty | Enum | Union
 ): ArmCommonTypeRecords {
   return program.stateMap(ArmStateKeys.armCommonDefinitions).get(entity) ?? { records: {} };
 }
@@ -114,14 +115,14 @@ export function $armCommonParameter(
  */
 export function $armCommonDefinition(
   context: DecoratorContext,
-  entity: Model,
+  entity: Model | Enum | Union,
   definitionName?: string,
   version?: string | EnumValue | ArmCommonTypeVersionSpec,
   referenceFile?: string
 ): void {
   // Use the name of the model type if not specified
   if (!definitionName) {
-    definitionName = entity.name;
+    definitionName = entity.name!;
   }
 
   storeCommonTypeRecord(context, entity, "definitions", definitionName, version, referenceFile);