Squash commit with signed

Author: Andrew Omondi

src/Microsoft.OpenApi.OData.Reader/Generator/OpenApiSchemaGenerator.cs

@@ -317,6 +317,18 @@ public static OpenApiSchema CreateEnumTypeSchema(this ODataContext context, IEdm
                 // whose value is the value of the unqualified annotation Core.Description of the enumeration type.
                 Description = context.Model.GetDescriptionAnnotation(enumType)
             };
+            
+            // If the enum is flagged, add the extension info to the description
+            if (context.Settings.AddEnumFlagsExtension && enumType.IsFlags)
+            {
+                var enumFlagsExtension = new OpenApiEnumFlagsExtension
+                {
+                    IsFlags = true,
+                    Style = "simple"
+                };
+                schema.Extensions.Add(enumFlagsExtension.Name, enumFlagsExtension);
+            }
+
             var extension = (context.Settings.OpenApiSpecVersion == OpenApiSpecVersion.OpenApi2_0 ||
                             context.Settings.OpenApiSpecVersion == OpenApiSpecVersion.OpenApi3_0 ) &&
                             context.Settings.AddEnumDescriptionExtension ? 

src/Microsoft.OpenApi.OData.Reader/Microsoft.OpenAPI.OData.Reader.csproj

@@ -15,7 +15,7 @@
     <TargetFrameworks>netstandard2.0</TargetFrameworks>
     <PackageId>Microsoft.OpenApi.OData</PackageId>
     <SignAssembly>true</SignAssembly>
-    <Version>1.5.0-preview2</Version>
+    <Version>1.5.0-preview3</Version>
     <Description>This package contains the codes you need to convert OData CSDL to Open API Document of Model.</Description>
     <Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
     <PackageTags>Microsoft OpenApi OData EDM</PackageTags>
@@ -24,6 +24,7 @@
 - Resolves operation ids for $count and overloaded functions paths #382, #383
 - Updates README #13, #253, #40
 - Fixes casing in default propertyName for `innerError` in the `ErrorMainSchema`
+- Adds support for `x-ms-enum-flags` extension for flagged enums
     </PackageReleaseNotes>
     <AssemblyName>Microsoft.OpenApi.OData.Reader</AssemblyName>
     <AssemblyOriginatorKeyFile>..\..\tool\Microsoft.OpenApi.OData.snk</AssemblyOriginatorKeyFile>

src/Microsoft.OpenApi.OData.Reader/OpenApiConvertSettings.cs

@@ -261,6 +261,11 @@ public string PathPrefix
         /// </summary>
         public bool AddEnumDescriptionExtension { get; set; } = false;
 
+        /// <summary>
+        /// Gets/sets a value indicating whether or not to add a "x-ms-enum-flags" extension to the enum type schema.
+        /// </summary>
+        public bool AddEnumFlagsExtension { get; set; } = true;
+        
         /// <summary>
         /// Gets/sets a value indicating whether the error responses should be described as a default response or as 4XX and 5XX error responses.
         /// </summary>
@@ -377,6 +382,7 @@ internal OpenApiConvertSettings Clone()
                 RequireDerivedTypesConstraintForODataTypeCastSegments = this.RequireDerivedTypesConstraintForODataTypeCastSegments,
                 EnableDeprecationInformation = this.EnableDeprecationInformation,
                 AddEnumDescriptionExtension = this.AddEnumDescriptionExtension,
+                AddEnumFlagsExtension = this.AddEnumFlagsExtension,
                 ErrorResponsesAsDefault = this.ErrorResponsesAsDefault,
                 InnerErrorComplexTypeName = this.InnerErrorComplexTypeName,
                 RequireRestrictionAnnotationsToGenerateComplexPropertyPaths = this.RequireRestrictionAnnotationsToGenerateComplexPropertyPaths,

src/Microsoft.OpenApi.OData.Reader/OpenApiExtensions/OpenApiEnumFlagsExtension.cs

@@ -0,0 +1,41 @@
+// ------------------------------------------------------------
+//  Copyright (c) Microsoft Corporation.  All rights reserved.
+//  Licensed under the MIT License (MIT). See LICENSE in the repo root for license information.
+// ------------------------------------------------------------
+
+using System;
+using Microsoft.OpenApi.Interfaces;
+using Microsoft.OpenApi.OData.Common;
+using Microsoft.OpenApi.Writers;
+
+namespace Microsoft.OpenApi.OData.OpenApiExtensions;
+
+/// <summary>
+/// Extension element for OpenAPI to add deprecation information. x-ms-enum-flags
+/// </summary>
+public class OpenApiEnumFlagsExtension : IOpenApiExtension
+{
+    /// <summary>
+    /// Name of the extension as used in the description.
+    /// </summary>
+    public string Name => "x-ms-enum-flags";
+    /// <summary>
+    /// Whether the enum is a flagged enum.
+    /// </summary>
+    public bool IsFlags { get; set; }
+    /// <summary>
+    /// The serialization style of the flagged enum.
+    /// </summary>
+    public string Style { get; set; }
+	/// <inheritdoc />
+    public void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion)
+    {
+        if(writer == null)
+            throw new ArgumentNullException(nameof(writer));
+        
+        writer.WriteStartObject();
+        writer.WriteProperty(nameof(IsFlags).ToFirstCharacterLowerCase(), IsFlags);
+        writer.WriteProperty(nameof(Style).ToFirstCharacterLowerCase(),Style);
+        writer.WriteEndObject();
+    } 
+}

src/Microsoft.OpenApi.OData.Reader/PublicAPI.Unshipped.txt

@@ -17,6 +17,8 @@ Microsoft.OpenApi.OData.Edm.ODataSegment.GetPathItemName(Microsoft.OpenApi.OData
 Microsoft.OpenApi.OData.Edm.ODataTypeCastSegment.ODataTypeCastSegment(Microsoft.OData.Edm.IEdmStructuredType structuredType, Microsoft.OData.Edm.IEdmModel model) -> void
 Microsoft.OpenApi.OData.OpenApiConvertSettings.AddAlternateKeyPaths.get -> bool
 Microsoft.OpenApi.OData.OpenApiConvertSettings.AddAlternateKeyPaths.set -> void
+Microsoft.OpenApi.OData.OpenApiConvertSettings.AddEnumFlagsExtension.get -> bool
+Microsoft.OpenApi.OData.OpenApiConvertSettings.AddEnumFlagsExtension.set -> void
 Microsoft.OpenApi.OData.OpenApiConvertSettings.AppendBoundOperationsOnDerivedTypeCastSegments.get -> bool
 Microsoft.OpenApi.OData.OpenApiConvertSettings.AppendBoundOperationsOnDerivedTypeCastSegments.set -> void
 Microsoft.OpenApi.OData.OpenApiConvertSettings.CustomHttpMethodLinkRelMapping.get -> System.Collections.Generic.Dictionary<Microsoft.OpenApi.OData.Vocabulary.Core.LinkRelKey, string>
@@ -48,6 +50,14 @@ Microsoft.OpenApi.OData.OpenApiConvertSettings.ShowExternalDocs.get -> bool
 Microsoft.OpenApi.OData.OpenApiConvertSettings.ShowExternalDocs.set -> void
 Microsoft.OpenApi.OData.OpenApiConvertSettings.UseSuccessStatusCodeRange.get -> bool
 Microsoft.OpenApi.OData.OpenApiConvertSettings.UseSuccessStatusCodeRange.set -> void
+Microsoft.OpenApi.OData.OpenApiExtensions.OpenApiEnumFlagsExtension
+Microsoft.OpenApi.OData.OpenApiExtensions.OpenApiEnumFlagsExtension.IsFlags.get -> bool
+Microsoft.OpenApi.OData.OpenApiExtensions.OpenApiEnumFlagsExtension.IsFlags.set -> void
+Microsoft.OpenApi.OData.OpenApiExtensions.OpenApiEnumFlagsExtension.Name.get -> string
+Microsoft.OpenApi.OData.OpenApiExtensions.OpenApiEnumFlagsExtension.OpenApiEnumFlagsExtension() -> void
+Microsoft.OpenApi.OData.OpenApiExtensions.OpenApiEnumFlagsExtension.Style.get -> string
+Microsoft.OpenApi.OData.OpenApiExtensions.OpenApiEnumFlagsExtension.Style.set -> void
+Microsoft.OpenApi.OData.OpenApiExtensions.OpenApiEnumFlagsExtension.Write(Microsoft.OpenApi.Writers.IOpenApiWriter writer, Microsoft.OpenApi.OpenApiSpecVersion specVersion) -> void
 Microsoft.OpenApi.OData.Vocabulary.Core.LinkRelKey
 Microsoft.OpenApi.OData.Vocabulary.Core.LinkRelKey.Action = 6 -> Microsoft.OpenApi.OData.Vocabulary.Core.LinkRelKey
 Microsoft.OpenApi.OData.Vocabulary.Core.LinkRelKey.Create = 2 -> Microsoft.OpenApi.OData.Vocabulary.Core.LinkRelKey

test/Microsoft.OpenAPI.OData.Reader.Tests/EdmModelOpenApiExtensionsTest.cs

@@ -243,6 +243,7 @@ public void TripServiceMetadataToOpenApiYamlWorks(OpenApiSpecVersion specVersion
             // Arrange
             IEdmModel model = EdmModelHelper.TripServiceModel;
 
+#pragma warning disable CS0618 // Type or member is obsolete
             OpenApiConvertSettings settings = new OpenApiConvertSettings
             {
                 EnableKeyAsSegment = true,
@@ -255,6 +256,7 @@ public void TripServiceMetadataToOpenApiYamlWorks(OpenApiSpecVersion specVersion
                 AppendBoundOperationsOnDerivedTypeCastSegments = true,
                 IncludeAssemblyInfo = false
             };
+#pragma warning restore CS0618 // Type or member is obsolete
 
             // Act
             string yaml = WriteEdmModelAsOpenApi(model, OpenApiFormat.Yaml, settings);

test/Microsoft.OpenAPI.OData.Reader.Tests/Generator/OpenApiParameterGeneratorTests.cs

@@ -299,7 +299,7 @@ public void CreateKeyParametersForAlternateKeyWithSinglePropertyWorks()
 
             // Assert
             Assert.NotNull(parameters);
-            Assert.Equal(1, parameters.Count);
+            Assert.Single(parameters);
             string json = altParameter.SerializeAsJson(OpenApiSpecVersion.OpenApi3_0);
             Assert.Equal(@"{
   ""name"": ""AltId"",

test/Microsoft.OpenAPI.OData.Reader.Tests/Generator/OpenApiSchemaGeneratorTests.cs

@@ -523,7 +523,7 @@ public void CreateComplexTypeWithBaseSchemaReturnCorrectSchema()
             Assert.Null(declaredSchema.OneOf);
 
             Assert.NotNull(declaredSchema.Properties);
-            Assert.Equal(1, declaredSchema.Properties.Count);
+            Assert.Single(declaredSchema.Properties);
             var property = Assert.Single(declaredSchema.Properties);
             Assert.Equal("Price", property.Key);
             Assert.Equal("decimal", property.Value.OneOf.FirstOrDefault(x => !string.IsNullOrEmpty(x.Format))?.Format);
@@ -674,7 +674,7 @@ public void CreateEntityTypeWithBaseSchemaReturnCorrectSchema()
             Assert.Null(declaredSchema.OneOf);
 
             Assert.NotNull(declaredSchema.Properties);
-            Assert.Equal(1, declaredSchema.Properties.Count);
+            Assert.Single(declaredSchema.Properties);
             var property = Assert.Single(declaredSchema.Properties);
             Assert.Equal("Name", property.Key);
             Assert.Equal("string", property.Value.Type);
@@ -750,7 +750,7 @@ public void CreateEntityTypeWithCrossReferenceBaseSchemaReturnCorrectSchema()
             Assert.Null(declaredSchema.OneOf);
 
             Assert.NotNull(declaredSchema.Properties);
-            Assert.Equal(1, declaredSchema.Properties.Count);
+            Assert.Single(declaredSchema.Properties);
             var property = Assert.Single(declaredSchema.Properties);
             Assert.Equal("Extra", property.Key);
             Assert.Equal("integer", property.Value.Type);

test/Microsoft.OpenAPI.OData.Reader.Tests/OpenApiExtensions/OpenApiEnumFlagsExtensionTests.cs

@@ -0,0 +1,89 @@
+// ------------------------------------------------------------
+//  Copyright (c) Microsoft Corporation.  All rights reserved.
+//  Licensed under the MIT License (MIT). See LICENSE in the repo root for license information.
+// ------------------------------------------------------------
+
+using System.IO;
+using Microsoft.OpenApi.Writers;
+using Xunit;
+
+namespace Microsoft.OpenApi.OData.OpenApiExtensions.Tests;
+
+public class OpenApiEnumFlagsExtensionTests
+{
+    [Fact]
+    public void ExtensionNameMatchesExpected()
+    {
+        // Arrange
+        OpenApiEnumFlagsExtension extension = new();
+
+        // Act
+        string name = extension.Name;
+        string expectedName = "x-ms-enum-flags";
+
+        // Assert
+        Assert.Equal(expectedName, name);
+    }
+
+    [Fact]
+    public void WritesDefaultValues()
+    {
+        // Arrange
+        OpenApiEnumFlagsExtension extension = new();
+        using TextWriter sWriter = new StringWriter();
+        OpenApiJsonWriter writer = new(sWriter);
+
+        // Act
+        extension.Write(writer, OpenApiSpecVersion.OpenApi3_0);
+        string result = sWriter.ToString();
+
+        // Assert
+        Assert.False(extension.IsFlags);
+        Assert.Null(extension.Style);
+        Assert.Contains("\"isFlags\": false", result);
+        Assert.DoesNotContain("\"style\"", result);
+    }
+    
+    [Fact]
+    public void WritesAllDefaultValues()
+    {
+        // Arrange
+        OpenApiEnumFlagsExtension extension = new() {
+            IsFlags = true
+        };
+        using TextWriter sWriter = new StringWriter();
+        OpenApiJsonWriter writer = new(sWriter);
+
+        // Act
+        extension.Write(writer, OpenApiSpecVersion.OpenApi3_0);
+        string result = sWriter.ToString();
+
+        // Assert
+        Assert.True(extension.IsFlags);
+        Assert.Null(extension.Style);
+        Assert.Contains("\"isFlags\": true", result);
+        Assert.DoesNotContain("\"style\":", result);
+    }
+
+    [Fact]
+    public void WritesAllValues()
+    {
+        // Arrange
+        OpenApiEnumFlagsExtension extension = new() {
+            IsFlags = true,
+            Style = "simple"
+        };
+        using TextWriter sWriter = new StringWriter();
+        OpenApiJsonWriter writer = new(sWriter);
+
+        // Act
+        extension.Write(writer, OpenApiSpecVersion.OpenApi3_0);
+        string result = sWriter.ToString();
+
+        // Assert
+        Assert.True(extension.IsFlags);
+        Assert.NotNull(extension.Style);
+        Assert.Contains("\"isFlags\": true", result);
+        Assert.Contains("\"style\": \"simple\"", result);
+    }
+}

test/Microsoft.OpenAPI.OData.Reader.Tests/Operation/ComplexPropertyPatchOperationHandlerTests.cs

@@ -41,7 +41,7 @@ public void CreateComplexPropertyDeleteOperationReturnsCorrectOperationForSingle
 		Assert.Equal("Update the BillingAddress value.", patch.Description);
 
 		Assert.NotNull(patch.Parameters);
-		Assert.Equal(1, patch.Parameters.Count); //id
+		Assert.Single(patch.Parameters); //id
 
 		Assert.NotNull(patch.Responses);
 		Assert.Equal(2, patch.Responses.Count);
@@ -85,7 +85,7 @@ public void CreateComplexPropertyPatchOperationReturnsCorrectOperationForCollect
         Assert.Equal("Update the BillingAddress value.", patch.Description);
 
 		Assert.NotNull(patch.Parameters);
-		Assert.Equal(1, patch.Parameters.Count); //id
+		Assert.Single(patch.Parameters); //id
 
 		Assert.NotNull(patch.Responses);
 		Assert.Equal(2, patch.Responses.Count);