Merge pull request #1279 from microsoft/vnext

Master refresh

Author: MaggieKimani1

.github/workflows/docker.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Check out the repo
         uses: actions/checkout@v3
       - name: Login to GitHub package feed
-        uses: docker/login-action@v2.1.0 
+        uses: docker/login-action@v2.2.0 
         with:
           username: ${{ secrets.ACR_USERNAME }}
           password: ${{ secrets.ACR_PASSWORD }}
@@ -30,13 +30,13 @@ jobs:
         id: getversion
       - name: Push to GitHub Packages - Nightly
         if: ${{ github.ref == 'refs/heads/vnext' }}
-        uses: docker/build-push-action@v4.0.0
+        uses: docker/build-push-action@v4.1.0
         with:
           push: true
           tags: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:nightly
       - name: Push to GitHub Packages - Release
         if: ${{ github.ref == 'refs/heads/master' }}
-        uses: docker/build-push-action@v4.0.0
+        uses: docker/build-push-action@v4.1.0
         with:
           push: true
           tags: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest,${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ steps.getversion.outputs.version }}

.vscode/launch.json

@@ -5,18 +5,36 @@
             // Use IntelliSense to find out which attributes exist for C# debugging
             // Use hover for the description of the existing attributes
             // For further information visit https://github.com/OmniSharp/omnisharp-vscode/blob/master/debugger-launchjson.md
-            "name": ".NET Core Launch (console)",
+            "name": "Launch Hidi",
             "type": "coreclr",
             "request": "launch",
             "preLaunchTask": "build",
             // If you have changed target frameworks, make sure to update the program path.
             "program": "${workspaceFolder}/src/Microsoft.OpenApi.Hidi/bin/Debug/net7.0/Microsoft.OpenApi.Hidi.dll",
-            "args": [],
+            "args": ["plugin", 
+                    "-m","C:\\Users\\darrmi\\src\\github\\microsoft\\openapi.net\\test\\Microsoft.OpenApi.Hidi.Tests\\UtilityFiles\\exampleapimanifest.json", 
+                    "--of","./output"],
             "cwd": "${workspaceFolder}/src/Microsoft.OpenApi.Hidi",
             // For more information about the 'console' field, see https://aka.ms/VSCode-CS-LaunchJson-Console
             "console": "internalConsole",
             "stopAtEntry": false
         },
+        {
+            // Use IntelliSense to find out which attributes exist for C# debugging
+            // Use hover for the description of the existing attributes
+            // For further information visit https://github.com/OmniSharp/omnisharp-vscode/blob/master/debugger-launchjson.md
+            "name": "Launch Workbench",
+            "type": "coreclr",
+            "request": "launch",
+            "preLaunchTask": "build",
+            // If you have changed target frameworks, make sure to update the program path.
+            "program": "${workspaceFolder}/src/Microsoft.OpenApi.WorkBench/bin/Debug/net7.0-windows/Microsoft.OpenApi.Workbench.exe",
+            "args": [],
+            "cwd": "${workspaceFolder}/src/Microsoft.OpenApi.Workbench",
+            // For more information about the 'console' field, see https://aka.ms/VSCode-CS-LaunchJson-Console
+            "console": "internalConsole",
+            "stopAtEntry": false
+        },        
         {
             "name": ".NET Core Attach",
             "type": "coreclr",

README.md

@@ -6,6 +6,7 @@
 |--|--|
 |Models and Writers|[![nuget](https://img.shields.io/nuget/v/Microsoft.OpenApi.svg)](https://www.nuget.org/packages/Microsoft.OpenApi/) |
 |Readers | [![nuget](https://img.shields.io/nuget/v/Microsoft.OpenApi.Readers.svg)](https://www.nuget.org/packages/Microsoft.OpenApi.Readers/) |
+|Hidi|[![nuget](https://img.shields.io/nuget/v/Microsoft.OpenApi.Hidi.svg)](https://www.nuget.org/packages/Microsoft.OpenApi.Hidi/)
 
 
 The **OpenAPI.NET** SDK contains a useful object model for OpenAPI documents in .NET along with common serializers to extract raw OpenAPI JSON and YAML documents from the model.
@@ -90,6 +91,28 @@ var outputString = openApiDocument.Serialize(OpenApiSpecVersion.OpenApi2_0, Open
 
 ```
 
+# Validating/Testing OpenAPI descriptions
+In order to test the validity of an OpenApi document, we avail the following tools:
+- [Microsoft.OpenApi.Hidi](https://www.nuget.org/packages/Microsoft.OpenApi.Hidi)
+
+    A commandline tool for validating and transforming OpenAPI descriptions. [Installation guidelines and documentation](https://github.com/microsoft/OpenAPI.NET/blob/vnext/src/Microsoft.OpenApi.Hidi/readme.md)
+
+- Microsoft.OpenApi.Workbench
+
+    A workbench tool consisting of a GUI where you can test and convert OpenAPI descriptions in both JSON and YAML from v2-->v3 and vice versa.
+
+    #### Installation guidelines:
+    1. Clone the repo locally by running this command:
+        `git clone https://github.com/microsoft/OpenAPI.NET.git`
+    2. Open the solution file `(.sln)` in the root of the project with Visual Studio
+    3. Navigate to the `src/Microsoft.OpenApi.Workbench` directory and set it as the startup project
+    4. Run the project and you'll see a GUI pop up resembling the one below:
+    
+    
+    <img src="https://user-images.githubusercontent.com/36787645/235884441-f45d2ef7-c27b-4e1a-a890-d6f7fbef87c3.png" width="700" height="500">
+    
+    5. Copy and paste your OpenAPI descriptions in the **Input Content** window or paste the path to the descriptions file in the **Input File** textbox and click on `Convert` to render the results.
+
 # Build Status
 
 |**master**|

src/Microsoft.OpenApi.Hidi/Extensions/CommandExtensions.cs

@@ -0,0 +1,19 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license. 
+
+using System.Collections.Generic;
+using System.CommandLine;
+
+namespace Microsoft.OpenApi.Hidi.Extensions
+{
+    internal static class CommandExtensions
+    {
+        public static void AddOptions(this Command command, IReadOnlyList<Option> options)
+        {
+            foreach (var option in options)
+            {
+                command.AddOption(option);
+            }
+        }
+    }
+}

src/Microsoft.OpenApi.Hidi/Extensions/OpenApiExtensibleExtensions.cs

@@ -0,0 +1,24 @@
+using Microsoft.OpenApi.Any;
+using Microsoft.OpenApi.Interfaces;
+using System.Collections.Generic;
+
+namespace Microsoft.OpenApi.Hidi.Extensions
+{
+    internal static class OpenApiExtensibleExtensions
+    {
+        /// <summary>
+        /// Gets an extension value from the extensions dictionary.
+        /// </summary>
+        /// <param name="extensions">A dictionary of <see cref="IOpenApiExtension"/>.</param>
+        /// <param name="extensionKey">The key corresponding to the <see cref="IOpenApiExtension"/>.</param>
+        /// <returns>A <see cref="string"/> value matching the provided extensionKey. Return null when extensionKey is not found. </returns>
+        public static string GetExtension(this IDictionary<string, IOpenApiExtension> extensions, string extensionKey)
+        {
+            if (extensions.TryGetValue(extensionKey, out var value) && value is OpenApiString castValue)
+            {
+                return castValue.Value;
+            }
+            return default;
+        }
+    }
+}

src/Microsoft.OpenApi.Hidi/Extensions/StringExtensions.cs

@@ -0,0 +1,43 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace Microsoft.OpenApi.Hidi.Extensions
+{
+    /// <summary>
+    /// Extension class for <see cref="string"/>.
+    /// </summary>
+    internal static class StringExtensions
+    {
+        /// <summary>
+        /// Checks if the specified searchValue is equal to the target string based on the specified <see cref="StringComparison"/>.
+        /// </summary>
+        /// <param name="target">The target string to commpare to.</param>
+        /// <param name="searchValue">The search string to seek.</param>
+        /// <param name="comparison">The <see cref="StringComparison"/> to use. This defaults to <see cref="StringComparison.OrdinalIgnoreCase"/>.</param>
+        /// <returns>true if the searchValue parameter occurs within this string; otherwise, false.</returns>
+        public static bool IsEquals(this string target, string searchValue, StringComparison comparison = StringComparison.OrdinalIgnoreCase)
+        {
+            if (string.IsNullOrWhiteSpace(target) || string.IsNullOrWhiteSpace(searchValue))
+            {
+                return false;
+            }
+            return target.Equals(searchValue, comparison);
+        }
+
+        /// <summary>
+        /// Splits the target string in substrings based on the specified char separator.
+        /// </summary>
+        /// <param name="target">The target string to split by char. </param>
+        /// <param name="separator">The char separator.</param>
+        /// <returns>An <see cref="IList{String}"/> containing substrings.</returns>
+        public static IList<string> SplitByChar(this string target, char separator)
+        {
+            if (string.IsNullOrWhiteSpace(target))
+            {
+                return new List<string>();
+            }
+            return target.Split(new char[] { separator }, StringSplitOptions.RemoveEmptyEntries).ToList();
+        }
+    }
+}