Release/1.3.1 preview2

.github/workflows/ci-cd.yml

@@ -49,7 +49,7 @@ jobs:
       - if: steps.conditionals_handler.outputs.is_default_branch == 'true'
         name: Bump GH tag
         id: tag_generator
-        uses: mathieudutour/github-tag-action@v5.4
+        uses: mathieudutour/github-tag-action@v6.0
         with: 
           github_token: ${{ secrets.GITHUB_TOKEN }}
           default_bump: false

.github/workflows/codeql-analysis.yml

@@ -2,6 +2,7 @@ name: CodeQL Analysis
 
 on:
   push:
+    branches: [ vnext ]
   pull_request:
   schedule:
     - cron: '0 8 * * *'

src/Directory.Build.props

@@ -3,6 +3,6 @@
     <AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0-*" PrivateAssets="All"/>
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1-*" PrivateAssets="All"/>
   </ItemGroup>
 </Project>

src/Microsoft.OpenApi.Hidi/Microsoft.OpenApi.Hidi.csproj

@@ -6,7 +6,7 @@
     <PackAsTool>true</PackAsTool>
     <ToolCommandName>hidi</ToolCommandName>
     <PackageOutputPath>./../../artifacts</PackageOutputPath>
-    <Version>0.5.0-preview</Version>
+    <Version>0.5.0-preview2</Version>
   </PropertyGroup>
 
   <ItemGroup>
@@ -19,7 +19,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Update="Microsoft.SourceLink.GitHub" Version="1.1.0-beta-20204-02" />
+    <PackageReference Update="Microsoft.SourceLink.GitHub" Version="1.1.1" />
   </ItemGroup>
 
 </Project>

src/Microsoft.OpenApi.Hidi/OpenApiService.cs

@@ -2,11 +2,13 @@
 // Licensed under the MIT license.
 
 using System;
+using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using System.Net;
 using System.Net.Http;
 using System.Text;
+using System.Text.Json;
 using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Readers;
@@ -16,15 +18,16 @@
 
 namespace Microsoft.OpenApi.Hidi
 {
-    static class OpenApiService
+    public static class OpenApiService
     {
         public static void ProcessOpenApiDocument(
             string input,
             FileInfo output,
-            OpenApiSpecVersion version,
-            OpenApiFormat format,
+            OpenApiSpecVersion? version,
+            OpenApiFormat? format,
             string filterByOperationIds,
             string filterByTags,
+            string filterByCollection,
             bool inline,
             bool resolveExternal)
         {
@@ -49,23 +52,30 @@ public static void ProcessOpenApiDocument(
             }
             ).ReadAsync(stream).GetAwaiter().GetResult();
 
-            OpenApiDocument document;
-            document = result.OpenApiDocument;
+            var document = result.OpenApiDocument;
+            Func<string, OperationType?, OpenApiOperation, bool> predicate;
 
             // Check if filter options are provided, then execute
             if (!string.IsNullOrEmpty(filterByOperationIds) && !string.IsNullOrEmpty(filterByTags))
             {
                 throw new InvalidOperationException("Cannot filter by operationIds and tags at the same time.");
             }
-
             if (!string.IsNullOrEmpty(filterByOperationIds))
             {
-                var predicate = OpenApiFilterService.CreatePredicate(operationIds: filterByOperationIds);
+                predicate = OpenApiFilterService.CreatePredicate(operationIds: filterByOperationIds);
                 document = OpenApiFilterService.CreateFilteredDocument(document, predicate);
             }
             if (!string.IsNullOrEmpty(filterByTags))
             {
-                var predicate = OpenApiFilterService.CreatePredicate(tags: filterByTags);
+                predicate = OpenApiFilterService.CreatePredicate(tags: filterByTags);
+                document = OpenApiFilterService.CreateFilteredDocument(document, predicate);
+            }
+
+            if (!string.IsNullOrEmpty(filterByCollection))
+            {
+                var fileStream = GetStream(filterByCollection);
+                var requestUrls = ParseJsonCollectionFile(fileStream);
+                predicate = OpenApiFilterService.CreatePredicate(requestUrls: requestUrls, source:document);
                 document = OpenApiFilterService.CreateFilteredDocument(document, predicate);
             }
 
@@ -91,13 +101,16 @@ public static void ProcessOpenApiDocument(
             {
                 ReferenceInline = inline ? ReferenceInlineSetting.InlineLocalReferences : ReferenceInlineSetting.DoNotInlineReferences
             };
-            IOpenApiWriter writer = format switch
+
+            var openApiFormat = format ?? GetOpenApiFormat(input);
+            var openApiVersion = version ?? result.OpenApiDiagnostic.SpecificationVersion;
+            IOpenApiWriter writer = openApiFormat switch
             {
                 OpenApiFormat.Json => new OpenApiJsonWriter(textWriter, settings),
                 OpenApiFormat.Yaml => new OpenApiYamlWriter(textWriter, settings),
                 _ => throw new ArgumentException("Unknown format"),
             };
-            document.Serialize(writer, version);
+            document.Serialize(writer, openApiVersion);
 
             textWriter.Flush();
         }
@@ -125,6 +138,38 @@ private static Stream GetStream(string input)
             return stream;
         }
 
+        /// <summary>
+        /// Takes in a file stream, parses the stream into a JsonDocument and gets a list of paths and Http methods
+        /// </summary>
+        /// <param name="stream"> A file stream.</param>
+        /// <returns> A dictionary of request urls and http methods from a collection.</returns>
+        public static Dictionary<string, List<string>> ParseJsonCollectionFile(Stream stream)
+        {
+            var requestUrls = new Dictionary<string, List<string>>();
+
+            // Convert file to JsonDocument
+            using var document = JsonDocument.Parse(stream);
+            var root = document.RootElement;
+            var itemElement = root.GetProperty("item");
+            foreach (var requestObject in itemElement.EnumerateArray().Select(item => item.GetProperty("request")))
+            {
+                // Fetch list of methods and urls from collection, store them in a dictionary
+                var path = requestObject.GetProperty("url").GetProperty("raw").ToString();
+                var method = requestObject.GetProperty("method").ToString();
+
+                if (!requestUrls.ContainsKey(path))
+                {
+                    requestUrls.Add(path, new List<string> { method });
+                }
+                else
+                {
+                    requestUrls[path].Add(method);
+                }
+            }
+
+            return requestUrls;
+        }
+
         internal static void ValidateOpenApiDocument(string input)
         {
             if (input == null)
@@ -156,5 +201,10 @@ internal static void ValidateOpenApiDocument(string input)
 
             Console.WriteLine(statsVisitor.GetStatisticsReport());
         }
+
+        private static OpenApiFormat GetOpenApiFormat(string input)
+        {
+            return !input.StartsWith("http") && Path.GetExtension(input) == ".json" ? OpenApiFormat.Json : OpenApiFormat.Yaml;
+        }
     }
 }

src/Microsoft.OpenApi.Hidi/Program.cs

@@ -30,9 +30,10 @@ static async Task<int> Main(string[] args)
                 new Option("--inline", "Inline $ref instances", typeof(bool) ),
                 new Option("--resolveExternal","Resolve external $refs", typeof(bool)),
                 new Option("--filterByOperationIds", "Filters OpenApiDocument by OperationId(s) provided", typeof(string)),
-                new Option("--filterByTags", "Filters OpenApiDocument by Tag(s) provided", typeof(string))
+                new Option("--filterByTags", "Filters OpenApiDocument by Tag(s) provided", typeof(string)),
+                new Option("--filterByCollection", "Filters OpenApiDocument by Postman collection provided", typeof(string))
             };
-            transformCommand.Handler = CommandHandler.Create<string, FileInfo, OpenApiSpecVersion, OpenApiFormat, string, string, bool, bool>(
+            transformCommand.Handler = CommandHandler.Create<string, FileInfo, OpenApiSpecVersion?, OpenApiFormat?, string, string, string, bool, bool>(
                 OpenApiService.ProcessOpenApiDocument);
 
             rootCommand.Add(transformCommand);

src/Microsoft.OpenApi.Readers/Microsoft.OpenApi.Readers.csproj

@@ -10,7 +10,7 @@
         <Company>Microsoft</Company>
         <Title>Microsoft.OpenApi.Readers</Title>
         <PackageId>Microsoft.OpenApi.Readers</PackageId>
-        <Version>1.3.1-preview</Version>
+        <Version>1.3.1-preview2</Version>
         <Description>OpenAPI.NET Readers for JSON and YAML documents</Description>
         <Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
         <PackageTags>OpenAPI .NET</PackageTags>
@@ -36,11 +36,11 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All"/>
+        <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All"/>
     </ItemGroup>
 
     <ItemGroup>
-        <PackageReference Include="SharpYaml" Version="1.6.6" />
+        <PackageReference Include="SharpYaml" Version="1.8.0" />
     </ItemGroup>
 
     <ItemGroup>

src/Microsoft.OpenApi.Readers/V3/OpenApiEncodingDeserializer.cs

@@ -31,15 +31,7 @@ internal static partial class OpenApiV3Deserializer
             {
                 "style", (o, n) =>
                 {
-                    ParameterStyle style;
-                    if (Enum.TryParse(n.GetScalarValue(), out style))
-                    {
-                        o.Style = style;
-                    }
-                    else
-                    {
-                        o.Style = null;
-                    }
+                    o.Style = n.GetScalarValue().GetEnumFromDisplayName<ParameterStyle>();
                 }
             },
             {

src/Microsoft.OpenApi.Readers/V3/OpenApiMediaTypeDeserializer.cs

@@ -81,11 +81,6 @@ public static OpenApiMediaType LoadMediaType(ParseNode node)
         {
             var mapNode = node.CheckMapNode(OpenApiConstants.Content);
 
-            if (!mapNode.Any())
-            {
-                return null;
-            }
-
             var mediaType = new OpenApiMediaType();
 
             ParseMap(mapNode, mediaType, _mediaTypeFixedFields, _mediaTypePatternFields);

src/Microsoft.OpenApi/Microsoft.OpenApi.csproj

@@ -11,7 +11,7 @@
         <Company>Microsoft</Company>
         <Title>Microsoft.OpenApi</Title>
         <PackageId>Microsoft.OpenApi</PackageId>
-        <Version>1.3.1-preview</Version>
+        <Version>1.3.1-preview2</Version>
         <Description>.NET models with JSON and YAML writers for OpenAPI specification</Description>
         <Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
         <PackageTags>OpenAPI .NET</PackageTags>
@@ -37,7 +37,8 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All" />
+        <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All" />
+        <PackageReference Include="System.Text.Json" Version="6.0.1" />
     </ItemGroup>
 
     <ItemGroup>