Added preview plugin command

Author: darrelmiller

.vscode/launch.json

@@ -11,9 +11,9 @@
             "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": ["transform", 
+            "args": ["plugin", 
                     "-m","C:\\Users\\darrmi\\src\\github\\microsoft\\openapi.net\\test\\Microsoft.OpenApi.Hidi.Tests\\UtilityFiles\\exampleapimanifest.json", 
-                    "-o","minimoose.yaml"],
+                    "--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",

src/Microsoft.OpenApi.Hidi/Handlers/PluginCommanHandler.cs renamed to src/Microsoft.OpenApi.Hidi/Handlers/PluginCommandHandler.cs

@@ -29,8 +29,9 @@
 using Microsoft.Extensions.Configuration;
 using Microsoft.OpenApi.Hidi.Utilities;
 using Microsoft.OpenApi.Hidi.Formatters;
-using Microsoft.OpenApi.ApiManifest;
 using System.Linq;
+using Microsoft.OpenApi.ApiManifest.OpenAI;
+using Microsoft.OpenApi.ApiManifest;
 
 namespace Microsoft.OpenApi.Hidi
 {
@@ -710,6 +711,7 @@ internal async static Task PluginManifest(HidiOptions options, ILogger<OpenApiSe
                     options.OpenApi = apiDependency.ApiDescripionUrl;
                 }   
 
+                
                 // Load OpenAPI document
                 OpenApiDocument document = await GetOpenApi(options.OpenApi, options.Csdl, options.CsdlFilter, options.SettingsConfig, options.InlineExternal, logger, cancellationToken, options.MetadataVersion);
 
@@ -718,11 +720,34 @@ internal async static Task PluginManifest(HidiOptions options, ILogger<OpenApiSe
                     document = ApplyFilters(options, logger, apiDependency, null, document, cancellationToken);
                 }
 
+                // Ensure path in options.OutputFolder exists
+                var outputFolder = new DirectoryInfo(options.OutputFolder);
+                if (!outputFolder.Exists)
+                {
+                    outputFolder.Create();
+                }
+                var slicedOpenApi = new FileInfo(Path.Combine(options.OutputFolder,"openapi.json"));
+                // Write OpenAPI to Output folder
+                WriteOpenApi(slicedOpenApi, true, options.InlineLocal, options.InlineExternal, OpenApiFormat.Json, OpenApiSpecVersion.OpenApi3_0, document, logger);
+                
                 // Create OpenAIPluginManifest from ApiDependency and OpenAPI document
+                var manifest = new OpenAIPluginManifest() {
+                    NameForHuman = document.Info.Title,
+                    DescriptionForHuman = document.Info.Description,
+                    Api = new() {
+                        Type = "openapi",
+                        Url = "./openapi.json"
+                    }
+                };
+                manifest.NameForModel = manifest.NameForHuman;
+                manifest.DescriptionForModel = manifest.DescriptionForHuman;
 
-
-                // Save OpenAI Plugin manifest and filtered OpenAI to output folder
-
+                // Write OpenAIPluginManifest to Output folder
+                var manifestFile = new FileInfo(Path.Combine(options.OutputFolder,"ai-plugin.json"));
+                using var file = new FileStream(manifestFile.FullName, FileMode.Create);
+                var jsonWriter = new Utf8JsonWriter(file, new JsonWriterOptions { Indented = true });
+                manifest.Write(jsonWriter);
+                jsonWriter.Flush();
         }
     }
 }

src/Microsoft.OpenApi.Hidi/OpenApiService.cs

@@ -11,7 +11,8 @@ internal class CommandOptions
         public Option<string> OpenApiDescriptionOption = new("--openapi", "Input OpenAPI description file path or URL");
         public Option<string> CsdlOption = new("--csdl", "Input CSDL file path or URL");
         public Option<string> CsdlFilterOption = new("--csdl-filter", "Comma delimited list of EntitySets or Singletons to filter CSDL on. e.g. tasks,accounts");
-        public Option<FileInfo> OutputOption = new("--output", "The output directory path for the generated file.") { Arity = ArgumentArity.ZeroOrOne };
+        public Option<FileInfo> OutputOption = new("--output", "The output file path for the generated file.") { Arity = ArgumentArity.ZeroOrOne };
+        public Option<string> OutputFolderOption = new("--output-folder", "The output directory path for the generated files.") { Arity = ArgumentArity.ZeroOrOne };
         public Option<bool> CleanOutputOption = new("--clean-output", "Overwrite an existing file");
         public Option<string> VersionOption = new("--version", "OpenAPI specification version");
         public Option<string> MetadataVersionOption = new("--metadata-version", "Graph metadata version to use.");
@@ -22,7 +23,7 @@ internal class CommandOptions
         public Option<string> FilterByOperationIdsOption = new("--filter-by-operationids", "Filters OpenApiDocument by comma delimited list of OperationId(s) provided");
         public Option<string> FilterByTagsOption = new("--filter-by-tags", "Filters OpenApiDocument by comma delimited list of Tag(s) provided. Also accepts a single regex.");
         public Option<string> FilterByCollectionOption = new("--filter-by-collection", "Filters OpenApiDocument by Postman collection provided. Provide path to collection file.");
-        public Option<string> FilterByApiManifestOption = new("--filter-by-manifest", "Filters OpenApiDocument by API Manifest provided. Provide path to API Manifest file.");
+        public Option<string> ManifestOption = new("--manifest", "Path to API manifest file to locate and filter an OpenApiDocument");
         public Option<bool> InlineLocalOption = new("--inline-local", "Inline local $ref instances");
         public Option<bool> InlineExternalOption = new("--inline-external", "Inline external $ref instances");
 
@@ -32,6 +33,7 @@ public CommandOptions()
             CsdlOption.AddAlias("--cs");
             CsdlFilterOption.AddAlias("--csf");
             OutputOption.AddAlias("-o");
+            OutputFolderOption.AddAlias("--of");
             CleanOutputOption.AddAlias("--co");
             VersionOption.AddAlias("-v");
             MetadataVersionOption.AddAlias("--mv");
@@ -42,7 +44,7 @@ public CommandOptions()
             FilterByOperationIdsOption.AddAlias("--op");
             FilterByTagsOption.AddAlias("--t");
             FilterByCollectionOption.AddAlias("-c");
-            FilterByApiManifestOption.AddAlias("-m");
+            ManifestOption.AddAlias("-m");
             InlineLocalOption.AddAlias("--il");
             InlineExternalOption.AddAlias("--ie");
         }
@@ -65,7 +67,6 @@ public IReadOnlyList<Option> GetAllCommandOptions()
                 FilterByOperationIdsOption,
                 FilterByTagsOption,
                 FilterByCollectionOption,
-                FilterByApiManifestOption,
                 InlineLocalOption,
                 InlineExternalOption
             };
@@ -92,5 +93,18 @@ public IReadOnlyList<Option> GetShowCommandOptions()
                 LogLevelOption
             };
         }
+
+        public IReadOnlyList<Option> GetPluginCommandOptions()
+        {
+            return new List<Option>
+            {
+
+                ManifestOption,
+                OutputFolderOption,
+                CleanOutputOption,
+                LogLevelOption
+            };
+        }
+
     }
 }

src/Microsoft.OpenApi.Hidi/Options/CommandOptions.cs

@@ -15,6 +15,7 @@ internal class HidiOptions
         public string Csdl { get; set; }
         public string CsdlFilter { get; set; }
         public FileInfo Output { get; set; }
+        public string OutputFolder { get; set; }
         public bool CleanOutput { get; set; }
         public string Version { get; set; }
         public string MetadataVersion { get; set; }
@@ -42,6 +43,7 @@ private void ParseHidiOptions(ParseResult parseResult, CommandOptions options)
             CsdlFilter = parseResult.GetValueForOption(options.CsdlFilterOption);
             Csdl = parseResult.GetValueForOption(options.CsdlOption);
             Output = parseResult.GetValueForOption(options.OutputOption);
+            OutputFolder = parseResult.GetValueForOption(options.OutputFolderOption);
             CleanOutput = parseResult.GetValueForOption(options.CleanOutputOption);
             Version = parseResult.GetValueForOption(options.VersionOption);
             MetadataVersion = parseResult.GetValueForOption(options.MetadataVersionOption);
@@ -56,7 +58,7 @@ private void ParseHidiOptions(ParseResult parseResult, CommandOptions options)
                 FilterByOperationIds = parseResult.GetValueForOption(options.FilterByOperationIdsOption),
                 FilterByTags = parseResult.GetValueForOption(options.FilterByTagsOption),
                 FilterByCollection = parseResult.GetValueForOption(options.FilterByCollectionOption),
-                FilterByApiManifest = parseResult.GetValueForOption(options.FilterByApiManifestOption)
+                FilterByApiManifest = parseResult.GetValueForOption(options.ManifestOption)
             };
         }
     }

src/Microsoft.OpenApi.Hidi/Options/HidiOptions.cs

@@ -27,20 +27,29 @@ internal static RootCommand CreateRootCommand()
             var commandOptions = new CommandOptions();
 
             var validateCommand = new Command("validate");
+            validateCommand.Description = "Validate an OpenAPI document.";
             validateCommand.AddOptions(commandOptions.GetValidateCommandOptions());
             validateCommand.Handler = new ValidateCommandHandler(commandOptions);
 
             var transformCommand = new Command("transform");
+            transformCommand.Description = "Transform an OpenAPI or CSDL document into a JSON/YAML OpenAPI v2/v3 document.";
             transformCommand.AddOptions(commandOptions.GetAllCommandOptions());
             transformCommand.Handler = new TransformCommandHandler(commandOptions);
 
             var showCommand = new Command("show");
+            showCommand.Description = "Create a visual representation of the paths in an OpenAPI document.";
             showCommand.AddOptions(commandOptions.GetShowCommandOptions());
             showCommand.Handler = new ShowCommandHandler(commandOptions);
 
+            var pluginCommand = new Command("plugin");
+            pluginCommand.Description = "Create manifest files for an OpenAI plugin [preview]";
+            pluginCommand.AddOptions(commandOptions.GetPluginCommandOptions());
+            pluginCommand.Handler = new PluginCommandHandler(commandOptions);
+
             rootCommand.Add(showCommand);
             rootCommand.Add(transformCommand);
             rootCommand.Add(validateCommand);
+            rootCommand.Add(pluginCommand);
             return rootCommand;
         }
     }