Merge branch 'main' into feat/enable-NRT

Author: MaggieKimani1

README.md

@@ -55,9 +55,9 @@ var document = new OpenApiDocument
     {
         ["/pets"] = new OpenApiPathItem
         {
-            Operations = new Dictionary<OperationType, OpenApiOperation>
+            Operations = new Dictionary<HttpMethod, OpenApiOperation>
             {
-                [OperationType.Get] = new OpenApiOperation
+                [HttpMethod.Get] = new OpenApiOperation
                 {
                     Description = "Returns all pets from the system that the user has access to",
                     Responses = new OpenApiResponses

docs/images/workbench.png

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Net.Http;
 using System.Text;
 using System.Text.RegularExpressions;
 using Humanizer;
@@ -53,11 +54,11 @@ public override void Visit(IOpenApiSchema schema)
 
         public override void Visit(IOpenApiPathItem pathItem)
         {
-            if (pathItem.Operations is not null && pathItem.Operations.TryGetValue(OperationType.Put, out var value) &&
+            if (pathItem.Operations is not null && pathItem.Operations.TryGetValue(HttpMethod.Put, out var value) &&
                 value.OperationId != null)
             {
                 var operationId = value.OperationId;
-                pathItem.Operations[OperationType.Put].OperationId = ResolvePutOperationId(operationId);
+                pathItem.Operations[HttpMethod.Put].OperationId = ResolvePutOperationId(operationId);
             }
 
             base.Visit(pathItem);

src/Microsoft.OpenApi.Hidi/Formatters/PowerShellFormatter.cs

@@ -261,9 +261,9 @@ private static async Task WriteOpenApiAsync(HidiOptions options, OpenApiFormat o
             return document;
         }
 
-        private static Func<string, OperationType?, OpenApiOperation, bool>? FilterOpenApiDocument(string? filterByOperationIds, string? filterByTags, Dictionary<string, List<string>> requestUrls, OpenApiDocument document, ILogger logger)
+        private static Func<string, HttpMethod, OpenApiOperation, bool>? FilterOpenApiDocument(string? filterByOperationIds, string? filterByTags, Dictionary<string, List<string>> requestUrls, OpenApiDocument document, ILogger logger)
         {
-            Func<string, OperationType?, OpenApiOperation, bool>? predicate = null;
+            Func<string, HttpMethod, OpenApiOperation, bool>? predicate = null;
 
             using (logger.BeginScope("Create Filter"))
             {

src/Microsoft.OpenApi.Hidi/OpenApiService.cs

@@ -17,21 +17,22 @@ Install [Microsoft.OpenApi.Hidi](https://www.nuget.org/packages/Microsoft.OpenAp
 
 ### .NET CLI(Global)
 
-	1. dotnet tool install --global Microsoft.OpenApi.Hidi --prerelease
-
+```bash
+dotnet tool install --global Microsoft.OpenApi.Hidi --prerelease
+```
 
 ### .NET CLI(local)
- 
-	1. dotnet new tool-manifest #if you are setting up the OpenAPI.NET repo 
-	2. dotnet tool install --local Microsoft.OpenApi.Hidi --prerelease 
 
+```bash 
+dotnet new tool-manifest #if you are setting up the OpenAPI.NET repo 
+dotnet tool install --local Microsoft.OpenApi.Hidi --prerelease 
+```
 
 
 
 ## How to use Hidi
 
-Once you've installed the package locally, you can invoke the Hidi by running: hidi [command]. 
-You can access the list of command options we have by running hidi -h 
+Once you've installed the package locally, you can invoke the Hidi by running: `hidi [command]`. You can access the list of command options we have by running `hidi -h` 
 The tool avails the following commands: 
 
 	• Validate  
@@ -57,63 +58,84 @@ It accepts the following command:
 	• --loglevel(-ll) - The log level to use when logging messages to the main output 
 	 
 
-**Example:** `hidi.exe validate --openapi C:\OpenApidocs\Mail.yml --loglevel trace` 
+#### Example:
 
-Run validate -h to see the options available.
+```bash
+hidi validate --openapi C:\OpenApidocs\Mail.yml --loglevel trace` 
+```
+
+> Run `hidi validate -h` to see the options available.
 
 ### Transform
 
 Used to convert file formats from JSON to YAML and vice versa and performs slicing of OpenAPI documents. 
 
 This command accepts the following parameters:
 
-	• --openapi(-d) - OpenAPI description file path in the local filesystem or a valid URL hosted on a HTTPS server 
-	• --csdl(--cs) - CSDL file path in the local filesystem or a valid URL hosted on a HTTPS server 
-	• --csdlfilter(--csf) - a filter parameter that a user can use to select a subset of a large CSDL file. They do so by providing a comma delimited list of EntitySet and Singleton names that appear in the EntityContainer. 
-	• --output(-o) - Output directory path for the transformed document.
-    • --output-folder(--of) - The output directory path for the generated files.
-	• --clean-ouput(--co) - an optional param that allows a user to overwrite an existing file.  
-	• --version(-v) - OpenAPI specification version.
-    • --metadata-version(--mv) - the metadata version to use.
-	• --format(-f) - File format 
-    • --terse-output(--to) - Produce terse json output
-    • --settings-path(--sp) - The configuration file with CSDL conversion settings.
-	• --loglevel(--ll) - The log level to use when logging messages to the main output 
-	• --inline-local - Inline local $ref instances 
-	• --inline-external(--ex) - Inline external $refs 
-	• --filterByOperationIds(--op) - Slice document based on OperationId(s) provided. Accepts a comma delimited list of operation ids. 
-	• --filterByTags(-t) - Slice document based on tag(s) provided. Accepts a comma delimited list of tags. 
-	• --filterByCollection(-c) - Slices the OpenAPI document based on the Postman Collection file generated by Resource Explorer 
-    • --manifest (-m) - Slices the OpenAPI document based on the requests defined in the API Manifest file referenced by the provided URI. For API manifests with multiple API Dependenties, use a fragment identifier to select the desired one. e.g ./apimanifest.json#example
+
+	• --openapi, (-d) - OpenAPI description file path in the local filesystem or a valid URL hosted on a HTTPS server 
+	• --csdl (--cs) - CSDL file path in the local filesystem or a valid URL hosted on a HTTPS server 
+	• --csdl-filter (--csf) - a filter parameter that a user can use to select a subset of a large CSDL file. They do so by providing a comma delimited list of EntitySet and Singleton names that appear in the EntityContainer. 
+	• --output (-o) - Output directory path for the transformed document.
+	• --clean-output (--co) - an optional param that allows a user to overwrite an existing file.  
+	• --version (-v) - OpenAPI specification version.
+    • --metadata-version (--mv) - the metadata version to use.
+	• --format (-f) - File format 
+    • --terse-output (--to) - Produce terse json output
+    • --settings-path (--sp) - The configuration file with CSDL conversion settings.
+	• --log-level (--ll) - The log level to use when logging messages to the main output 
+	• --inline-local (--il) - Inline local $ref instances 
+	• --inline-external (--ie) - Inline external $refs instances
+	• --filter-by-operationids(--op) - Slice document based on OperationId(s) provided. Accepts a comma delimited list of operation ids. 
+	• --filter-by-tags (--t) - Slice document based on tag(s) provided. Accepts a comma delimited list of tags. 
+	• --filter-by-collection (-c) - Slices the OpenAPI document based on the Postman Collection file generated by Resource Explorer 
 
- **Examples:**  
+ #### Examples:  
 
-	1. Filtering by OperationIds  
-	hidi transform -d files\People.yml -f yaml -o files\People.yml -v OpenApi3_0 --op users_UpdateInsights --co 
-	 
-	2. Filtering by Postman collection 
-	hidi transform --openapi files\People.yml --format yaml --output files\People2.yml --version OpenApi3_0 --filterByCollection Graph-Collection-0017059134807617005.postman_collection.json 
-	 
-	3. CSDL--->OpenAPI conversion and filtering 
-	hidi transform --csdl Files/Todo.xml --output Files/Todo-subset.yml --format yaml --version OpenApi3_0 --filterByOperationIds Todos.Todo.UpdateTodo 
-	 
-	4. CSDL Filtering by EntitySets and Singletons 
-	hidi transform --cs dataverse.csdl --csdlFilter "appointments,opportunities" -o appointmentsAndOpportunities.yaml --ll trace 
-	 
-Run transform -h to see all the available usage options.
+1. Filtering by OperationIds  
+
+```bash
+hidi transform -d files\People.yml -f yaml -o files\People.yml -v OpenApi3_0 --op users_UpdateInsights --co 
+```
+
+2. Filtering by Postman collection 
+
+```bash	
+hidi transform --openapi files\People.yml --format yaml --output files\People2.yml --version OpenApi3_0 --filter-by-collection Graph-Collection-0017059134807617005.postman_collection.json 
+```
+
+3. CSDL--->OpenAPI conversion and filtering 
+
+```bash
+hidi transform --csdl Files/Todo.xml --output Files/Todo-subset.yml --format yaml --version OpenApi3_0 --filter-by-operationids Todos.Todo.UpdateTodo 
+```	 
+	
+4. CSDL Filtering by EntitySets and Singletons 
+
+```bash
+hidi transform --cs dataverse.csdl --csdl-filter "appointments,opportunities" -o appointmentsAndOpportunities.yaml --ll trace 
+```
+
+> Run `hidi transform -h` to see all the available usage options.
 
 ### Show
 
 This command accepts an OpenAPI document as an input parameter and generates a Markdown file that contains a diagram of the API using Mermaid syntax.
 
-**Examples:**
+#### Examples:
 
-    1. hidi show -d files\People.yml -o People.md -ll trace
+```bash
+hidi show -d files\People.yml -o People.md -ll trace
+```
 
 ### Plugin
 
 This command generates an OpenAI style Plugin manifest and minimal OpenAPI file based on the provided API Manifest
 
-**Examples:**
+#### Examples:
+
+```bash
+hidi plugin -m exampleApiManifest.yml -o mypluginfolder 
+```
 
-    1. hidi plugin -m exampleApiManifest.yml -o mypluginfolder 
+> Run `hidi plugin -h` to see all the available usage options.

src/Microsoft.OpenApi.Hidi/readme.md

@@ -11,9 +11,9 @@
 using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Reader;
-using Microsoft.OpenApi.Readers;
 using Microsoft.OpenApi.Services;
 using Microsoft.OpenApi.Validations;
+using Microsoft.OpenApi.Writers;
 
 namespace Microsoft.OpenApi.Workbench
 {
@@ -242,7 +242,7 @@ internal async Task ParseDocumentAsync()
                         : new("file://" + Path.GetDirectoryName(_inputFile) + "/");
                 }
 
-                var readResult = await OpenApiDocument.LoadAsync(stream, Format.GetDisplayName());
+                var readResult = await OpenApiDocument.LoadAsync(stream, Format.GetDisplayName().ToLowerInvariant(), settings);
                 var document = readResult.Document;
                 var context = readResult.Diagnostic;
 
@@ -298,13 +298,13 @@ internal async Task ParseDocumentAsync()
         /// </summary>
         private async Task<string> WriteContentsAsync(OpenApiDocument document)
         {
-            var outputStream = new MemoryStream();
+            using var outputStream = new MemoryStream();
 
             await document.SerializeAsync(
                 outputStream,
                 Version,
                 Format,
-                (Writers.OpenApiWriterSettings)new()
+                new OpenApiWriterSettings()
                 {
                     InlineLocalReferences = InlineLocal,
                     InlineExternalReferences = InlineExternal

src/Microsoft.OpenApi.Workbench/MainModel.cs

@@ -1,5 +1,6 @@
 
 using System.Collections.Generic;
+using System.Net.Http;
 using Microsoft.OpenApi.Interfaces;
 
 namespace Microsoft.OpenApi.Models.Interfaces;
@@ -13,7 +14,7 @@ public interface IOpenApiPathItem : IOpenApiDescribedElement, IOpenApiSummarized
     /// <summary>
     /// Gets the definition of operations on this path.
     /// </summary>
-    public IDictionary<OperationType, OpenApiOperation>? Operations { get; }
+    public IDictionary<HttpMethod, OpenApiOperation> Operations { get; }
 
     /// <summary>
     /// An alternative server array to service all operations in this path.

src/Microsoft.OpenApi/Models/Interfaces/IOpenApiPathItem.cs

@@ -147,6 +147,35 @@ public OpenApiDocument(OpenApiDocument? document)
             BaseUri = document?.BaseUri != null ? document.BaseUri : new(OpenApiConstants.BaseRegistryUri + Guid.NewGuid());
         }
 
+        /// <summary>
+        /// Serialize <see cref="OpenApiDocument"/> to an Open API document using the specified version.
+        /// </summary>
+        /// <param name="version">The Open API specification version to serialize the document as.</param>
+        /// <param name="writer">The <see cref="IOpenApiWriter"/> to serialize the document to.</param>
+        /// <exception cref="ArgumentOutOfRangeException">
+        /// <paramref name="version"/> is not a supported Open API specification version.
+        /// </exception>
+        public void SerializeAs(OpenApiSpecVersion version, IOpenApiWriter writer)
+        {
+            switch (version)
+            {
+                case OpenApiSpecVersion.OpenApi2_0:
+                    SerializeAsV2(writer);
+                    break;
+
+                case OpenApiSpecVersion.OpenApi3_0:
+                    SerializeAsV3(writer);
+                    break;
+
+                case OpenApiSpecVersion.OpenApi3_1:
+                    SerializeAsV31(writer);
+                    break;
+
+                default:
+                    throw new ArgumentOutOfRangeException(nameof(version), version, string.Format(Properties.SRResource.OpenApiSpecVersionNotSupported, version));
+            }
+        }
+
         /// <summary>
         /// Serialize <see cref="OpenApiDocument"/> to Open API v3.1 document.
         /// </summary>

src/Microsoft.OpenApi/Models/OpenApiDocument.cs

@@ -3,6 +3,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Net.Http;
 using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Interfaces;
 using Microsoft.OpenApi.Models.Interfaces;
@@ -22,8 +23,8 @@ public class OpenApiPathItem : IOpenApiExtensible, IOpenApiReferenceable, IOpenA
         public string? Description { get; set; }
 
         /// <inheritdoc/>
-        public IDictionary<OperationType, OpenApiOperation>? Operations { get; set; }
-            = new Dictionary<OperationType, OpenApiOperation>();
+        public IDictionary<HttpMethod, OpenApiOperation>? Operations { get; set; }
+            = new Dictionary<HttpMethod, OpenApiOperation>();
 
         /// <inheritdoc/>
         public IList<OpenApiServer>? Servers { get; set; } = [];
@@ -39,7 +40,7 @@ public class OpenApiPathItem : IOpenApiExtensible, IOpenApiReferenceable, IOpenA
         /// </summary>
         /// <param name="operationType">The operation type kind.</param>
         /// <param name="operation">The operation item.</param>
-        public void AddOperation(OperationType operationType, OpenApiOperation operation)
+        public void AddOperation(HttpMethod operationType, OpenApiOperation operation)
         {
             if (Operations is not null)
             {
@@ -60,7 +61,7 @@ internal OpenApiPathItem(IOpenApiPathItem pathItem)
             Utils.CheckArgumentNull(pathItem);
             Summary = pathItem.Summary ?? Summary;
             Description = pathItem.Description ?? Description;
-            Operations = pathItem.Operations != null ? new Dictionary<OperationType, OpenApiOperation>(pathItem.Operations) : null;
+            Operations = pathItem.Operations != null ? new Dictionary<HttpMethod, OpenApiOperation>(pathItem.Operations) : null;
             Servers = pathItem.Servers != null ? new List<OpenApiServer>(pathItem.Servers) : null;
             Parameters = pathItem.Parameters != null ? new List<IOpenApiParameter>(pathItem.Parameters) : null;
             Extensions = pathItem.Extensions != null ? new Dictionary<string, IOpenApiExtension>(pathItem.Extensions) : null;
@@ -97,13 +98,13 @@ public void SerializeAsV2(IOpenApiWriter writer)
             {
                 foreach (var operation in Operations)
                 {
-                    if (operation.Key != OperationType.Trace)
-                    {
-                        writer.WriteOptionalObject(
-                            operation.Key.GetDisplayName(),
-                            operation.Value,
-                            (w, o) => o.SerializeAsV2(w));
-                    }
+                  if (operation.Key != HttpMethod.Trace)
+                  {
+                      writer.WriteOptionalObject(
+                          operation.Key.Method.ToLowerInvariant(),
+                          operation.Value,
+                          (w, o) => o.SerializeAsV2(w));
+                  }
                 }
             }
 
@@ -143,9 +144,9 @@ internal virtual void SerializeInternal(IOpenApiWriter writer, OpenApiSpecVersio
                 foreach (var operation in Operations)
                 {
                     writer.WriteOptionalObject(
-                        operation.Key.GetDisplayName(),
-                        operation.Value,
-                        callback);
+                    operation.Key.Method.ToLowerInvariant(),
+                    operation.Value,
+                    callback);
                 }
             }