ShowOpenApiDocumentAsync(HidiOptions options, ILogger logger, CancellationToken cancellationToken = default)
+ {
+ try
+ {
+ if (string.IsNullOrEmpty(options.OpenApi) && string.IsNullOrEmpty(options.Csdl))
+ {
+ throw new ArgumentException("Please input a file path or URL");
+ }
+
+ var format = OpenApiModelFactory.GetFormat(options.OpenApi);
+ var document = await GetOpenApiAsync(options, format, logger, null, cancellationToken).ConfigureAwait(false);
+
+ using (logger.BeginScope("Creating diagram"))
+ {
+ // If output is null, create a HTML file in the user's temporary directory
+ var sourceUrl = (string.IsNullOrEmpty(options.OpenApi), string.IsNullOrEmpty(options.Csdl)) switch {
+ (false, _) => options.OpenApi!,
+ (_, false) => options.Csdl!,
+ _ => throw new InvalidOperationException("No input file path or URL provided")
+ };
+ if (options.Output == null)
+ {
+ var tempPath = Path.GetTempPath() + "/hidi/";
+ if (!File.Exists(tempPath))
+ {
+ Directory.CreateDirectory(tempPath);
+ }
+
+ var fileName = Path.GetRandomFileName();
+
+ var output = new FileInfo(Path.Combine(tempPath, fileName + ".html"));
+ using (var file = new FileStream(output.FullName, FileMode.Create))
+ {
+ using var writer = new StreamWriter(file);
+ WriteTreeDocumentAsHtml(sourceUrl, document, writer);
+ }
+ logger.LogTrace("Created Html document with diagram ");
+
+ // Launch a browser to display the output html file
+ using var process = new Process();
+ process.StartInfo.FileName = output.FullName;
+ process.StartInfo.UseShellExecute = true;
+ process.Start();
+
+ return output.FullName;
+ }
+ else // Write diagram as Markdown document to output file
+ {
+ using (var file = new FileStream(options.Output.FullName, FileMode.Create))
+ {
+ using var writer = new StreamWriter(file);
+ WriteTreeDocumentAsMarkdown(sourceUrl, document, writer);
+ }
+ logger.LogTrace("Created markdown document with diagram ");
+ return options.Output.FullName;
+ }
+ }
+ }
+ catch (TaskCanceledException)
+ {
+ await Console.Error.WriteLineAsync("CTRL+C pressed, aborting the operation.").ConfigureAwait(false);
+ }
+ catch (Exception ex)
+ {
+ throw new InvalidOperationException($"Could not generate the document, reason: {ex.Message}", ex);
+ }
+ return null;
+ }
+
+ private static void LogErrors(ILogger logger, ReadResult result)
+ {
+ var context = result.OpenApiDiagnostic;
+ if (context.Errors.Count != 0)
+ {
+ using (logger.BeginScope("Detected errors"))
+ {
+ foreach (var error in context.Errors)
+ {
+ logger.LogError("Detected error during parsing: {Error}", error.ToString());
+ }
+ }
+ }
+ }
+
+ internal static void WriteTreeDocumentAsMarkdown(string openapiUrl, OpenApiDocument document, StreamWriter writer)
+ {
+ var rootNode = OpenApiUrlTreeNode.Create(document, "main");
+
+ writer.WriteLine("# " + document.Info.Title);
+ writer.WriteLine();
+ writer.WriteLine("API Description: " + openapiUrl);
+
+ writer.WriteLine(@"");
+ // write a span for each mermaidcolorscheme
+ foreach (var style in OpenApiUrlTreeNode.MermaidNodeStyles)
+ {
+ writer.WriteLine($"{style.Key.Replace("_", " ", StringComparison.OrdinalIgnoreCase)}");
+ }
+ writer.WriteLine("
");
+ writer.WriteLine();
+ writer.WriteLine("```mermaid");
+ rootNode.WriteMermaid(writer);
+ writer.WriteLine("```");
+ }
+
+ internal static void WriteTreeDocumentAsHtml(string sourceUrl, OpenApiDocument document, StreamWriter writer, bool asHtmlFile = false)
+ {
+ var rootNode = OpenApiUrlTreeNode.Create(document, "main");
+
+ writer.WriteLine(
+ """
+
+
+
+
+
+
+
+
+ """);
+ writer.WriteLine("" + document.Info.Title + "
");
+ writer.WriteLine();
+ writer.WriteLine($"");
+
+ writer.WriteLine(@"");
+ // write a span for each mermaidcolorscheme
+ foreach (var style in OpenApiUrlTreeNode.MermaidNodeStyles)
+ {
+ writer.WriteLine($"{style.Key.Replace("_", " ", StringComparison.OrdinalIgnoreCase)}");
+ }
+
+ writer.WriteLine("
");
+ writer.WriteLine("
");
+ writer.WriteLine("");
+ rootNode.WriteMermaid(writer);
+ writer.WriteLine("");
+
+ // Write script tag to include JS library for rendering markdown
+ writer.WriteLine(
+ """
+
+ """);
+ // Write script tag to include JS library for rendering mermaid
+ writer.WriteLine(" OpenApiDescriptionOption = new("--openapi", "Input OpenAPI description file path or URL");
+ public readonly Option CsdlOption = new("--csdl", "Input CSDL file path or URL");
+ public readonly Option CsdlFilterOption = new("--csdl-filter", "Comma delimited list of EntitySets or Singletons to filter CSDL on. e.g. tasks,accounts");
+ public readonly Option OutputOption = new("--output", "The output file path for the generated file.") { Arity = ArgumentArity.ZeroOrOne };
+ public readonly Option OutputFolderOption = new("--output-folder", "The output directory path for the generated files.") { Arity = ArgumentArity.ZeroOrOne };
+ public readonly Option CleanOutputOption = new("--clean-output", "Overwrite an existing file");
+ public readonly Option VersionOption = new("--version", "OpenAPI specification version");
+ public readonly Option MetadataVersionOption = new("--metadata-version", "Graph metadata version to use.");
+ public readonly Option FormatOption = new("--format", "File format");
+ public readonly Option TerseOutputOption = new("--terse-output", "Produce terse json output");
+ public readonly Option SettingsFileOption = new("--settings-path", "The configuration file with CSDL conversion settings.");
+ public readonly Option LogLevelOption = new("--log-level", () => LogLevel.Information, "The log level to use when logging messages to the main output.");
+ public readonly Option FilterByOperationIdsOption = new("--filter-by-operationids", "Filters OpenApiDocument by comma delimited list of OperationId(s) provided");
+ public readonly Option FilterByTagsOption = new("--filter-by-tags", "Filters OpenApiDocument by comma delimited list of Tag(s) provided. Also accepts a single regex.");
+ public readonly Option FilterByCollectionOption = new("--filter-by-collection", "Filters OpenApiDocument by Postman collection provided. Provide path to collection file.");
+ public readonly Option ManifestOption = new("--manifest", "Path to API manifest file to locate and filter an OpenApiDocument");
+ public readonly Option InlineLocalOption = new("--inline-local", "Inline local $ref instances");
+ public readonly Option InlineExternalOption = new("--inline-external", "Inline external $ref instances");
+
+ public CommandOptions()
+ {
+ OpenApiDescriptionOption.AddAlias("-d");
+ CsdlOption.AddAlias("--cs");
+ CsdlFilterOption.AddAlias("--csf");
+ OutputOption.AddAlias("-o");
+ OutputFolderOption.AddAlias("--of");
+ CleanOutputOption.AddAlias("--co");
+ VersionOption.AddAlias("-v");
+ MetadataVersionOption.AddAlias("--mv");
+ FormatOption.AddAlias("-f");
+ TerseOutputOption.AddAlias("--to");
+ SettingsFileOption.AddAlias("--sp");
+ LogLevelOption.AddAlias("--ll");
+ FilterByOperationIdsOption.AddAlias("--op");
+ FilterByTagsOption.AddAlias("--t");
+ FilterByCollectionOption.AddAlias("-c");
+ ManifestOption.AddAlias("-m");
+ InlineLocalOption.AddAlias("--il");
+ InlineExternalOption.AddAlias("--ie");
+ }
+
+ public IReadOnlyList
+
+ 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.
# Contributing
@@ -110,4 +127,4 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
-To provide feedback and ask questions you can use Stack Overflow with the [OpenAPI.NET](https://stackoverflow.com/questions/tagged/openapi.net) tag or use the OpenAPI.NET Slack channel which you can join by registering for the HTTP APIs team at http://slack.httpapis.com.
+To provide feedback and ask questions you can use Stack Overflow with the [OpenAPI.NET](https://stackoverflow.com/questions/tagged/openapi.net) tag.
diff --git a/SECURITY.md b/SECURITY.md
new file mode 100644
index 000000000..766e6f887
--- /dev/null
+++ b/SECURITY.md
@@ -0,0 +1,41 @@
+
+
+## Security
+
+Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).
+
+If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below.
+
+## Reporting Security Issues
+
+**Please do not report security vulnerabilities through public GitHub issues.**
+
+Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report).
+
+If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/msrc/pgp-key-msrc).
+
+You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
+
+Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
+
+ * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+ * Full paths of source file(s) related to the manifestation of the issue
+ * The location of the affected source code (tag/branch/commit or direct URL)
+ * Any special configuration required to reproduce the issue
+ * Step-by-step instructions to reproduce the issue
+ * Proof-of-concept or exploit code (if possible)
+ * Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.
+
+If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://microsoft.com/msrc/bounty) page for more details about our active programs.
+
+## Preferred Languages
+
+We prefer all communications to be in English.
+
+## Policy
+
+Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/msrc/cvd).
+
+
diff --git a/build.cmd b/build.cmd
index b3612c9ed..43cc95956 100644
--- a/build.cmd
+++ b/build.cmd
@@ -1,21 +1,21 @@
@echo off
-Echo Building Microsoft.OpenApi
+Echo Building Microsoft.OpenApi
-SET PROJ=%~dp0src\Microsoft.OpenApi\Microsoft.OpenApi.csproj
+SET PROJ=%~dp0src\Microsoft.OpenApi\Microsoft.OpenApi.csproj
dotnet msbuild %PROJ% /t:restore /p:Configuration=Release
dotnet msbuild %PROJ% /t:build /p:Configuration=Release
dotnet msbuild %PROJ% /t:pack /p:Configuration=Release;PackageOutputPath=%~dp0artifacts
Echo Building Microsoft.OpenApi.Readers
-SET PROJ=%~dp0src\Microsoft.OpenApi.Readers\Microsoft.OpenApi.Readers.csproj
+SET PROJ=%~dp0src\Microsoft.OpenApi.Readers\Microsoft.OpenApi.Readers.csproj
dotnet msbuild %PROJ% /t:restore /p:Configuration=Release
dotnet msbuild %PROJ% /t:build /p:Configuration=Release
dotnet msbuild %PROJ% /t:pack /p:Configuration=Release;PackageOutputPath=%~dp0artifacts
-Echo Building Microsoft.OpenApi.Tool
+Echo Building Microsoft.OpenApi.Hidi
-SET PROJ=%~dp0src\Microsoft.OpenApi.Tool\Microsoft.OpenApi.Tool.csproj
+SET PROJ=%~dp0src\Microsoft.OpenApi.Hidi\Microsoft.OpenApi.Hidi.csproj
dotnet msbuild %PROJ% /t:restore /p:Configuration=Release
dotnet msbuild %PROJ% /t:build /p:Configuration=Release
dotnet msbuild %PROJ% /t:pack /p:Configuration=Release;PackageOutputPath=%~dp0artifacts
diff --git a/docs/CI-CD_DOCUMENTATION.md b/docs/CI-CD_DOCUMENTATION.md
deleted file mode 100644
index 40053cf82..000000000
--- a/docs/CI-CD_DOCUMENTATION.md
+++ /dev/null
@@ -1,81 +0,0 @@
-# CI/CD documentation
-
-## 1. Run workflow manually
-
-1. Go to the project's GitHub repository and click on the **Actions** tab
-
-2. From the "Workflows" list on the left, click on "CI/CD Pipeline"
-
-3. On the right, next to the "This workflow has a workflow_dispatch event trigger" label, click on the "Run workflow" dropdown, make sure the default branch is selected (if not manually changed, should be main or master) in the "Use workflow from" dropdown and click the "Run workflow" button
-
-
-
-NOTE: **screenshots are only exemplary**
-
-