Merge branch 'mk/align-hidi-params-with-kiota' into mk/feature/convert-csdl-to-openapi

Author: MaggieKimani1

src/Microsoft.OpenApi.Hidi/OpenApiService.cs

@@ -24,19 +24,19 @@ namespace Microsoft.OpenApi.Hidi
     public static class OpenApiService
     {
         public static void ProcessOpenApiDocument(
-            string input,
+            string openapi,
             FileInfo output,
             OpenApiSpecVersion? version,
             OpenApiFormat? format,
-            string filterByOperationIds,
-            string filterByTags,
-            string filterByCollection,
+            string filterbyoperationids,
+            string filterbytags,
+            string filterbycollection,
             bool inline,
-            bool resolveExternal)
+            bool resolveexternal)
         {
-            if (string.IsNullOrEmpty(input))
+            if (string.IsNullOrEmpty(openapi))
             {
-                throw new ArgumentNullException(nameof(input));
+                throw new ArgumentNullException(nameof(openapi));
             }
             if(output == null)
             {
@@ -86,24 +86,24 @@ public static void ProcessOpenApiDocument(
             Func<string, OperationType?, OpenApiOperation, bool> predicate;
 
             // Check if filter options are provided, then execute
-            if (!string.IsNullOrEmpty(filterByOperationIds) && !string.IsNullOrEmpty(filterByTags))
+            if (!string.IsNullOrEmpty(filterbyoperationids) && !string.IsNullOrEmpty(filterbytags))
             {
                 throw new InvalidOperationException("Cannot filter by operationIds and tags at the same time.");
             }
-            if (!string.IsNullOrEmpty(filterByOperationIds))
+            if (!string.IsNullOrEmpty(filterbyoperationids))
             {
-                predicate = OpenApiFilterService.CreatePredicate(operationIds: filterByOperationIds);
+                predicate = OpenApiFilterService.CreatePredicate(operationIds: filterbyoperationids);
                 document = OpenApiFilterService.CreateFilteredDocument(document, predicate);
             }
-            if (!string.IsNullOrEmpty(filterByTags))
+            if (!string.IsNullOrEmpty(filterbytags))
             {
-                predicate = OpenApiFilterService.CreatePredicate(tags: filterByTags);
+                predicate = OpenApiFilterService.CreatePredicate(tags: filterbytags);
                 document = OpenApiFilterService.CreateFilteredDocument(document, predicate);
             }
 
-            if (!string.IsNullOrEmpty(filterByCollection))
+            if (!string.IsNullOrEmpty(filterbycollection))
             {
-                var fileStream = GetStream(filterByCollection);
+                var fileStream = GetStream(filterbycollection);
                 var requestUrls = ParseJsonCollectionFile(fileStream);
                 predicate = OpenApiFilterService.CreatePredicate(requestUrls: requestUrls, source:document);
                 document = OpenApiFilterService.CreateFilteredDocument(document, predicate);
@@ -118,7 +118,7 @@ public static void ProcessOpenApiDocument(
                 ReferenceInline = inline ? ReferenceInlineSetting.InlineLocalReferences : ReferenceInlineSetting.DoNotInlineReferences
             };
 
-            var openApiFormat = format ?? GetOpenApiFormat(input);
+            var openApiFormat = format ?? GetOpenApiFormat(openapi);
             var openApiVersion = version ?? result.OpenApiDiagnostic.SpecificationVersion;
             IOpenApiWriter writer = openApiFormat switch
             {
@@ -182,7 +182,7 @@ public static OpenApiDocument FixReferences(OpenApiDocument document)
         private static Stream GetStream(string input)
         {
             Stream stream;
-            if (input.StartsWith("http"))
+            if (openapi.StartsWith("http"))
             {
                 var httpClient = new HttpClient(new HttpClientHandler()
                 {
@@ -191,11 +191,11 @@ private static Stream GetStream(string input)
                 {
                     DefaultRequestVersion = HttpVersion.Version20
                 };
-                stream = httpClient.GetStreamAsync(input).Result;
+                stream = httpClient.GetStreamAsync(openapi).Result;
             }
             else
             {
-                var fileInput = new FileInfo(input);
+                var fileInput = new FileInfo(openapi);
                 stream = fileInput.OpenRead();
             }
 
@@ -234,14 +234,14 @@ public static Dictionary<string, List<string>> ParseJsonCollectionFile(Stream st
             return requestUrls;
         }
 
-        internal static void ValidateOpenApiDocument(string input)
+        internal static void ValidateOpenApiDocument(string openapi)
         {
-            if (input == null)
+            if (openapi == null)
             {
-                throw new ArgumentNullException("input");
+                throw new ArgumentNullException("openapi");
             }
 
-            var stream = GetStream(input);
+            var stream = GetStream(openapi);
 
             OpenApiDocument document;
 
@@ -266,9 +266,9 @@ internal static void ValidateOpenApiDocument(string input)
             Console.WriteLine(statsVisitor.GetStatisticsReport());
         }
 
-        private static OpenApiFormat GetOpenApiFormat(string input)
+        private static OpenApiFormat GetOpenApiFormat(string openapi)
         {
-            return !input.StartsWith("http") && Path.GetExtension(input) == ".json" ? OpenApiFormat.Json : OpenApiFormat.Yaml;
+            return !openapi.StartsWith("http") && Path.GetExtension(openapi) == ".json" ? OpenApiFormat.Json : OpenApiFormat.Yaml;
         }
     }
 }

src/Microsoft.OpenApi.Hidi/Program.cs

@@ -14,24 +14,52 @@ static async Task<int> Main(string[] args)
         {
             var rootCommand = new RootCommand() {
             };
+            
+            // command option parameters and aliases
+            var descriptionOption = new Option("--openapi", "Input OpenAPI description file path or URL", typeof(string));
+            descriptionOption.AddAlias("-d");
+
+            var outputOption = new Option("--output", "The output directory path for the generated file.", typeof(FileInfo), () => "./output", arity: ArgumentArity.ZeroOrOne);
+            outputOption.AddAlias("-o");
+
+            var versionOption = new Option("--version", "OpenAPI specification version", typeof(OpenApiSpecVersion));
+            versionOption.AddAlias("-v");
+
+            var formatOption = new Option("--format", "File format", typeof(OpenApiFormat));
+            formatOption.AddAlias("-f");
+;
+            var inlineOption = new Option("--inline", "Inline $ref instances", typeof(bool));
+            inlineOption.AddAlias("-i");
+;
+            var resolveExternalOption = new Option("--resolve-external", "Resolve external $refs", typeof(bool));
+            resolveExternalOption.AddAlias("-ex");
+;
+            var filterByOperationIdsOption = new Option("--filter-by-operationids", "Filters OpenApiDocument by OperationId(s) provided", typeof(string));
+            filterByOperationIdsOption.AddAlias("-op");
+;
+            var filterByTagsOption = new Option("--filter-by-tags", "Filters OpenApiDocument by Tag(s) provided", typeof(string));
+            filterByTagsOption.AddAlias("-t");
+;
+            var filterByCollectionOption = new Option("--filter-by-collection", "Filters OpenApiDocument by Postman collection provided", typeof(string));
+            filterByCollectionOption.AddAlias("-c");
 
             var validateCommand = new Command("validate")
             {
-                new Option("--input", "Input OpenAPI description file path or URL", typeof(string) )
+                descriptionOption
             };
             validateCommand.Handler = CommandHandler.Create<string>(OpenApiService.ValidateOpenApiDocument);
 
             var transformCommand = new Command("transform")
             {
-                new Option("--input", "Input OpenAPI description, JSON or CSDL file path or URL", typeof(string) ),
-                new Option("--output","Output OpenAPI description file", typeof(FileInfo), arity: ArgumentArity.ZeroOrOne),
-                new Option("--version", "OpenAPI specification version", typeof(OpenApiSpecVersion)),
-                new Option("--format", "File format",typeof(OpenApiFormat) ),
-                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("--filterByCollection", "Filters OpenApiDocument by Postman collection provided", typeof(string))
+                descriptionOption,
+                outputOption,
+                versionOption,
+                formatOption,
+                inlineOption,
+                resolveExternalOption,
+                filterByOperationIdsOption,
+                filterByTagsOption,
+                filterByCollectionOption
             };
             transformCommand.Handler = CommandHandler.Create<string, FileInfo, OpenApiSpecVersion?, OpenApiFormat?, string, string, string, bool, bool>(
                 OpenApiService.ProcessOpenApiDocument);