");
// write a span for each mermaidcolorscheme
foreach (var style in OpenApiUrlTreeNode.MermaidNodeStyles)
@@ -622,8 +681,8 @@ internal static void WriteTreeDocumentAsHtml(string sourceUrl, OpenApiDocument d
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 GetAllCommandOptions()
+ {
+ return new List
+ {
+ OpenApiDescriptionOption,
+ CsdlOption,
+ CsdlFilterOption,
+ OutputOption,
+ CleanOutputOption,
+ VersionOption,
+ MetadataVersionOption,
+ FormatOption,
+ TerseOutputOption,
+ SettingsFileOption,
+ LogLevelOption,
+ FilterByOperationIdsOption,
+ FilterByTagsOption,
+ FilterByCollectionOption,
+ InlineLocalOption,
+ InlineExternalOption
+ };
+ }
+
+ public IReadOnlyList GetValidateCommandOptions()
+ {
+ return new List
+ {
+ OpenApiDescriptionOption,
+ LogLevelOption,
+ };
+ }
+
+ public IReadOnlyList GetShowCommandOptions()
+ {
+ return new List
+ {
+ OpenApiDescriptionOption,
+ CsdlOption,
+ CsdlFilterOption,
+ OutputOption,
+ CleanOutputOption,
+ LogLevelOption
+ };
+ }
+
+ public IReadOnlyList GetPluginCommandOptions()
+ {
+ return new List
+ {
+ ManifestOption,
+ OutputFolderOption,
+ CleanOutputOption,
+ LogLevelOption
+ };
+ }
+
+ }
+}
diff --git a/src/Microsoft.OpenApi.Hidi/Options/FilterOptions.cs b/src/Microsoft.OpenApi.Hidi/Options/FilterOptions.cs
new file mode 100644
index 000000000..ffdb568de
--- /dev/null
+++ b/src/Microsoft.OpenApi.Hidi/Options/FilterOptions.cs
@@ -0,0 +1,13 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
+namespace Microsoft.OpenApi.Hidi.Options
+{
+ internal class FilterOptions
+ {
+ public string FilterByOperationIds { get; internal set; }
+ public string FilterByTags { get; internal set; }
+ public string FilterByCollection { get; internal set; }
+ public string FilterByApiManifest { get; internal set; }
+ }
+}
diff --git a/src/Microsoft.OpenApi.Hidi/Options/HidiOptions.cs b/src/Microsoft.OpenApi.Hidi/Options/HidiOptions.cs
new file mode 100644
index 000000000..a7f16d872
--- /dev/null
+++ b/src/Microsoft.OpenApi.Hidi/Options/HidiOptions.cs
@@ -0,0 +1,65 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
+using System.CommandLine.Parsing;
+using System.IO;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Logging;
+using Microsoft.OpenApi.Hidi.Utilities;
+
+namespace Microsoft.OpenApi.Hidi.Options
+{
+ internal class HidiOptions
+ {
+ public string OpenApi { get; set; }
+ 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; }
+ public OpenApiFormat? OpenApiFormat { get; set; }
+ public bool TerseOutput { get; set; }
+ public IConfiguration SettingsConfig { get; set; }
+ public LogLevel LogLevel { get; set; }
+ public bool InlineLocal { get; set; }
+ public bool InlineExternal { get; set; }
+ public FilterOptions FilterOptions { get; set; }
+
+ public HidiOptions(ParseResult parseResult, CommandOptions options)
+ {
+ ParseHidiOptions(parseResult, options);
+ }
+
+ public HidiOptions()
+ {
+
+ }
+
+ private void ParseHidiOptions(ParseResult parseResult, CommandOptions options)
+ {
+ OpenApi = parseResult.GetValueForOption(options.OpenApiDescriptionOption);
+ 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);
+ OpenApiFormat = parseResult.GetValueForOption(options.FormatOption);
+ TerseOutput = parseResult.GetValueForOption(options.TerseOutputOption);
+ SettingsConfig = SettingsUtilities.GetConfiguration(parseResult.GetValueForOption(options.SettingsFileOption));
+ LogLevel = parseResult.GetValueForOption(options.LogLevelOption);
+ InlineLocal = parseResult.GetValueForOption(options.InlineLocalOption);
+ InlineExternal = parseResult.GetValueForOption(options.InlineExternalOption);
+ FilterOptions = new FilterOptions
+ {
+ FilterByOperationIds = parseResult.GetValueForOption(options.FilterByOperationIdsOption),
+ FilterByTags = parseResult.GetValueForOption(options.FilterByTagsOption),
+ FilterByCollection = parseResult.GetValueForOption(options.FilterByCollectionOption),
+ FilterByApiManifest = parseResult.GetValueForOption(options.ManifestOption)
+ };
+ }
+ }
+}
diff --git a/src/Microsoft.OpenApi.Hidi/Program.cs b/src/Microsoft.OpenApi.Hidi/Program.cs
index 5c5bf691a..fb523e952 100644
--- a/src/Microsoft.OpenApi.Hidi/Program.cs
+++ b/src/Microsoft.OpenApi.Hidi/Program.cs
@@ -1,15 +1,12 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.
-using System;
using System.CommandLine;
using System.CommandLine.Parsing;
-using System.Diagnostics;
-using System.IO;
-using System.Threading;
using System.Threading.Tasks;
-using Microsoft.Extensions.Logging;
using Microsoft.OpenApi.Hidi.Handlers;
+using Microsoft.OpenApi.Hidi.Options;
+using Microsoft.OpenApi.Hidi.Extensions;
namespace Microsoft.OpenApi.Hidi
{
@@ -27,129 +24,32 @@ internal static RootCommand CreateRootCommand()
{
var rootCommand = new RootCommand() { };
- // command option parameters and aliases
- var descriptionOption = new Option("--openapi", "Input OpenAPI description file path or URL");
- descriptionOption.AddAlias("-d");
+ var commandOptions = new CommandOptions();
- var csdlOption = new Option("--csdl", "Input CSDL file path or URL");
- csdlOption.AddAlias("--cs");
+ var validateCommand = new Command("validate");
+ validateCommand.Description = "Validate an OpenAPI document.";
+ validateCommand.AddOptions(commandOptions.GetValidateCommandOptions());
+ validateCommand.Handler = new ValidateCommandHandler(commandOptions);
- var csdlFilterOption = new Option("--csdl-filter", "Comma delimited list of EntitySets or Singletons to filter CSDL on. e.g. tasks,accounts");
- csdlFilterOption.AddAlias("--csf");
+ 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 outputOption = new Option("--output", "The output directory path for the generated file.") { Arity = ArgumentArity.ZeroOrOne };
- outputOption.AddAlias("-o");
+ 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 cleanOutputOption = new Option("--clean-output", "Overwrite an existing file");
- cleanOutputOption.AddAlias("--co");
-
- var versionOption = new Option("--version", "OpenAPI specification version");
- versionOption.AddAlias("-v");
-
- var metadataVersionOption = new Option("--metadata-version", "Graph metadata version to use.");
- metadataVersionOption.AddAlias("--mv");
-
- var formatOption = new Option("--format", "File format");
- formatOption.AddAlias("-f");
-
- var terseOutputOption = new Option("--terse-output", "Produce terse json output");
- terseOutputOption.AddAlias("--to");
-
- var settingsFileOption = new Option("--settings-path", "The configuration file with CSDL conversion settings.");
- settingsFileOption.AddAlias("--sp");
-
- var logLevelOption = new Option("--log-level", () => LogLevel.Information, "The log level to use when logging messages to the main output.");
- logLevelOption.AddAlias("--ll");
-
- var filterByOperationIdsOption = new Option("--filter-by-operationids", "Filters OpenApiDocument by comma delimited list of OperationId(s) provided");
- filterByOperationIdsOption.AddAlias("--op");
-
- var filterByTagsOption = new Option("--filter-by-tags", "Filters OpenApiDocument by comma delimited list of Tag(s) provided. Also accepts a single regex.");
- filterByTagsOption.AddAlias("--t");
-
- var filterByCollectionOption = new Option("--filter-by-collection", "Filters OpenApiDocument by Postman collection provided. Provide path to collection file.");
- filterByCollectionOption.AddAlias("-c");
-
- var inlineLocalOption = new Option("--inline-local", "Inline local $ref instances");
- inlineLocalOption.AddAlias("--il");
-
- var inlineExternalOption = new Option("--inline-external", "Inline external $ref instances");
- inlineExternalOption.AddAlias("--ie");
-
- var validateCommand = new Command("validate")
- {
- descriptionOption,
- logLevelOption
- };
-
- validateCommand.Handler = new ValidateCommandHandler
- {
- DescriptionOption = descriptionOption,
- LogLevelOption = logLevelOption
- };
-
- var transformCommand = new Command("transform")
- {
- descriptionOption,
- csdlOption,
- csdlFilterOption,
- outputOption,
- cleanOutputOption,
- versionOption,
- metadataVersionOption,
- formatOption,
- terseOutputOption,
- settingsFileOption,
- logLevelOption,
- filterByOperationIdsOption,
- filterByTagsOption,
- filterByCollectionOption,
- inlineLocalOption,
- inlineExternalOption
- };
-
- transformCommand.Handler = new TransformCommandHandler
- {
- DescriptionOption = descriptionOption,
- CsdlOption = csdlOption,
- CsdlFilterOption = csdlFilterOption,
- OutputOption = outputOption,
- CleanOutputOption = cleanOutputOption,
- VersionOption = versionOption,
- MetadataVersionOption = metadataVersionOption,
- FormatOption = formatOption,
- TerseOutputOption = terseOutputOption,
- SettingsFileOption = settingsFileOption,
- LogLevelOption = logLevelOption,
- FilterByOperationIdsOption = filterByOperationIdsOption,
- FilterByTagsOption = filterByTagsOption,
- FilterByCollectionOption = filterByCollectionOption,
- InlineLocalOption = inlineLocalOption,
- InlineExternalOption = inlineExternalOption
- };
-
- var showCommand = new Command("show")
- {
- descriptionOption,
- csdlOption,
- csdlFilterOption,
- logLevelOption,
- outputOption,
- cleanOutputOption
- };
-
- showCommand.Handler = new ShowCommandHandler
- {
- DescriptionOption = descriptionOption,
- CsdlOption = csdlOption,
- CsdlFilterOption = csdlFilterOption,
- OutputOption = outputOption,
- LogLevelOption = logLevelOption
- };
+ 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;
}
}
diff --git a/src/Microsoft.OpenApi.Hidi/Properties/AssemblyInfo.cs b/src/Microsoft.OpenApi.Hidi/Properties/AssemblyInfo.cs
new file mode 100644
index 000000000..e5a59206e
--- /dev/null
+++ b/src/Microsoft.OpenApi.Hidi/Properties/AssemblyInfo.cs
@@ -0,0 +1,4 @@
+
+using System.Runtime.CompilerServices;
+
+[assembly: InternalsVisibleTo("DynamicProxyGenAssembly2, PublicKey=0024000004800000940000000602000000240000525341310004000001000100c547cac37abd99c8db225ef2f6c8a3602f3b3606cc9891605d02baa56104f4cfc0734aa39b93bf7852f7d9266654753cc297e7d2edfe0bac1cdcf9f717241550e0a7b191195b7667bb4f64bcb8e2121380fd1d9d46ad2d92d2d15605093924cceaf74c4861eff62abf69b9291ed0a340e113be11e6a7d3113e92484cf7045cc7")]
diff --git a/src/Microsoft.OpenApi.Hidi/Utilities/SettingsUtilities.cs b/src/Microsoft.OpenApi.Hidi/Utilities/SettingsUtilities.cs
new file mode 100644
index 000000000..6e00e2ba3
--- /dev/null
+++ b/src/Microsoft.OpenApi.Hidi/Utilities/SettingsUtilities.cs
@@ -0,0 +1,32 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
+using Microsoft.Extensions.Configuration;
+using Microsoft.OpenApi.OData;
+
+namespace Microsoft.OpenApi.Hidi.Utilities
+{
+ internal static class SettingsUtilities
+ {
+ internal static IConfiguration GetConfiguration(string settingsFile = null)
+ {
+ settingsFile ??= "appsettings.json";
+
+ IConfiguration config = new ConfigurationBuilder()
+ .AddJsonFile(settingsFile, true)
+ .Build();
+
+ return config;
+ }
+
+ internal static OpenApiConvertSettings GetOpenApiConvertSettings(IConfiguration config, string metadataVersion = null)
+ {
+ if (config == null) { throw new System.ArgumentNullException(nameof(config)); }
+ var settings = new OpenApiConvertSettings();
+ if (!string.IsNullOrEmpty(metadataVersion))
+ settings.SemVerVersion = metadataVersion;
+ config.GetSection(nameof(OpenApiConvertSettings)).Bind(settings);
+ return settings;
+ }
+ }
+}
diff --git a/src/Microsoft.OpenApi.Hidi/readme.md b/src/Microsoft.OpenApi.Hidi/readme.md
index a6283817e..111ee704b 100644
--- a/src/Microsoft.OpenApi.Hidi/readme.md
+++ b/src/Microsoft.OpenApi.Hidi/readme.md
@@ -80,6 +80,7 @@ This command accepts the following parameters:
• --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
+ • --filterByManifest (-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
**Examples:**
@@ -95,7 +96,7 @@ This command accepts the following parameters:
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.
+Run transform -h to see all the available usage options.
### Show
@@ -104,3 +105,11 @@ This command accepts an OpenAPI document as an input parameter and generates a M
**Examples:**
1. 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:**
+
+ 1. hidi plugin -m exampleApiManifest.yml -o mypluginfolder
diff --git a/src/Microsoft.OpenApi.Readers/Microsoft.OpenApi.Readers.csproj b/src/Microsoft.OpenApi.Readers/Microsoft.OpenApi.Readers.csproj
index 7a1681459..81c08752d 100644
--- a/src/Microsoft.OpenApi.Readers/Microsoft.OpenApi.Readers.csproj
+++ b/src/Microsoft.OpenApi.Readers/Microsoft.OpenApi.Readers.csproj
@@ -10,7 +10,7 @@
Microsoft
Microsoft.OpenApi.Readers
Microsoft.OpenApi.Readers
- 1.6.4
+ 1.6.5
OpenAPI.NET Readers for JSON and YAML documents
© Microsoft Corporation. All rights reserved.
OpenAPI .NET
diff --git a/src/Microsoft.OpenApi.Readers/OpenApiDiagnostic.cs b/src/Microsoft.OpenApi.Readers/OpenApiDiagnostic.cs
index c3178ccfb..0ffac77e7 100644
--- a/src/Microsoft.OpenApi.Readers/OpenApiDiagnostic.cs
+++ b/src/Microsoft.OpenApi.Readers/OpenApiDiagnostic.cs
@@ -26,5 +26,48 @@ public class OpenApiDiagnostic : IDiagnostic
/// Open API specification version of the document parsed.
///
public OpenApiSpecVersion SpecificationVersion { get; set; }
+
+ ///
+ /// Append another set of diagnostic Errors and Warnings to this one, this may be appended from another external
+ /// document's parsing and we want to indicate which file it originated from.
+ ///
+ ///
+/// Extension class for IList to add the Method "AddRange" used above
+///
+internal static class IDiagnosticExtensions
+{
+ ///
+ /// Extension method for IList so that another list can be added to the current list.
+ ///
+ /// (this ICollection collection, IEnumerable enumerable)
+ {
+ if (collection is null || enumerable is null) return;
+
+ foreach (var cur in enumerable)
+ {
+ collection.Add(cur);
+ }
}
}
diff --git a/src/Microsoft.OpenApi.Readers/OpenApiYamlDocumentReader.cs b/src/Microsoft.OpenApi.Readers/OpenApiYamlDocumentReader.cs
index f6fd2325e..5b87ab7ae 100644
--- a/src/Microsoft.OpenApi.Readers/OpenApiYamlDocumentReader.cs
+++ b/src/Microsoft.OpenApi.Readers/OpenApiYamlDocumentReader.cs
@@ -102,7 +102,13 @@ public async Task ReadAsync(YamlDocument input, CancellationToken ca
if (_settings.LoadExternalRefs)
{
- await LoadExternalRefs(document, cancellationToken);
+ var diagnosticExternalRefs = await LoadExternalRefs(document, cancellationToken);
+ // Merge diagnostics of external reference
+ if (diagnosticExternalRefs != null)
+ {
+ diagnostic.Errors.AddRange(diagnosticExternalRefs.Errors);
+ diagnostic.Warnings.AddRange(diagnosticExternalRefs.Warnings);
+ }
}
ResolveReferences(diagnostic, document);
@@ -133,7 +139,7 @@ public async Task ReadAsync(YamlDocument input, CancellationToken ca
};
}
- private async Task LoadExternalRefs(OpenApiDocument document, CancellationToken cancellationToken)
+ private async Task LoadExternalRefs(OpenApiDocument document, CancellationToken cancellationToken)
{
// Create workspace for all documents to live in.
var openApiWorkSpace = new OpenApiWorkspace();
@@ -141,7 +147,7 @@ private async Task LoadExternalRefs(OpenApiDocument document, CancellationToken
// Load this root document into the workspace
var streamLoader = new DefaultStreamLoader(_settings.BaseUrl);
var workspaceLoader = new OpenApiWorkspaceLoader(openApiWorkSpace, _settings.CustomExternalLoader ?? streamLoader, _settings);
- await workspaceLoader.LoadAsync(new OpenApiReference() { ExternalResource = "/" }, document, cancellationToken);
+ return await workspaceLoader.LoadAsync(new OpenApiReference() { ExternalResource = "/" }, document, cancellationToken);
}
private void ResolveReferences(OpenApiDiagnostic diagnostic, OpenApiDocument document)
diff --git a/src/Microsoft.OpenApi.Readers/Services/OpenApiWorkspaceLoader.cs b/src/Microsoft.OpenApi.Readers/Services/OpenApiWorkspaceLoader.cs
index 32e2db128..79f6206d0 100644
--- a/src/Microsoft.OpenApi.Readers/Services/OpenApiWorkspaceLoader.cs
+++ b/src/Microsoft.OpenApi.Readers/Services/OpenApiWorkspaceLoader.cs
@@ -24,7 +24,7 @@ public OpenApiWorkspaceLoader(OpenApiWorkspace workspace, IStreamLoader loader,
_readerSettings = readerSettings;
}
- internal async Task LoadAsync(OpenApiReference reference, OpenApiDocument document, CancellationToken cancellationToken)
+ internal async Task LoadAsync(OpenApiReference reference, OpenApiDocument document, CancellationToken cancellationToken, OpenApiDiagnostic diagnostic = null)
{
_workspace.AddDocument(reference.ExternalResource, document);
document.Workspace = _workspace;
@@ -36,6 +36,11 @@ internal async Task LoadAsync(OpenApiReference reference, OpenApiDocument docume
var reader = new OpenApiStreamReader(_readerSettings);
+ if (diagnostic is null)
+ {
+ diagnostic = new OpenApiDiagnostic();
+ }
+
// Walk references
foreach (var item in referenceCollector.References)
{
@@ -43,10 +48,21 @@ internal async Task LoadAsync(OpenApiReference reference, OpenApiDocument docume
if (!_workspace.Contains(item.ExternalResource))
{
var input = await _loader.LoadAsync(new Uri(item.ExternalResource, UriKind.RelativeOrAbsolute));
- var result = await reader.ReadAsync(input, cancellationToken); // TODO merge diagnostics
- await LoadAsync(item, result.OpenApiDocument, cancellationToken);
+ var result = await reader.ReadAsync(input, cancellationToken);
+ // Merge diagnostics
+ if (result.OpenApiDiagnostic != null)
+ {
+ diagnostic.AppendDiagnostic(result.OpenApiDiagnostic, item.ExternalResource);
+ }
+ if (result.OpenApiDocument != null)
+ {
+ var loadDiagnostic = await LoadAsync(item, result.OpenApiDocument, cancellationToken, diagnostic);
+ diagnostic = loadDiagnostic;
+ }
}
}
+
+ return diagnostic;
}
}
}
diff --git a/src/Microsoft.OpenApi.Readers/V3/OpenApiPathItemDeserializer.cs b/src/Microsoft.OpenApi.Readers/V3/OpenApiPathItemDeserializer.cs
index 3bb10a555..371e7da80 100644
--- a/src/Microsoft.OpenApi.Readers/V3/OpenApiPathItemDeserializer.cs
+++ b/src/Microsoft.OpenApi.Readers/V3/OpenApiPathItemDeserializer.cs
@@ -56,6 +56,13 @@ public static OpenApiPathItem LoadPathItem(ParseNode node)
{
var mapNode = node.CheckMapNode("PathItem");
+ var pointer = mapNode.GetReferencePointer();
+ if (pointer != null)
+ {
+ var refObject = mapNode.GetReferencedObject(ReferenceType.Path, pointer);
+ return refObject;
+ }
+
var pathItem = new OpenApiPathItem();
ParseMap(mapNode, pathItem, _pathItemFixedFields, _pathItemPatternFields);
diff --git a/src/Microsoft.OpenApi.Readers/V3/OpenApiV3VersionService.cs b/src/Microsoft.OpenApi.Readers/V3/OpenApiV3VersionService.cs
index ebe372d40..889ce4cb8 100644
--- a/src/Microsoft.OpenApi.Readers/V3/OpenApiV3VersionService.cs
+++ b/src/Microsoft.OpenApi.Readers/V3/OpenApiV3VersionService.cs
@@ -21,6 +21,8 @@ internal class OpenApiV3VersionService : IOpenApiVersionService
{
public OpenApiDiagnostic Diagnostic { get; }
+ private static readonly char[] _pathSeparator = new char[] { '/' };
+
///
/// Create Parsing Context
///
@@ -129,6 +131,20 @@ public OpenApiReference ConvertToOpenApiReference(
}
id = localSegments[3];
}
+ else if (id.StartsWith("/paths/"))
+ {
+ var localSegments = segments[1].Split(_pathSeparator, StringSplitOptions.RemoveEmptyEntries);
+ if (localSegments.Length == 2)
+ {
+ // The reference of a path may contain JSON escape character ~1 for the forward-slash character, replace this otherwise
+ // the reference cannot be resolved.
+ id = localSegments[1].Replace("~1", "/");
+ }
+ else
+ {
+ throw new OpenApiException("Referenced Path mismatch");
+ }
+ }
else
{
openApiReference.IsFragrament = true;
diff --git a/src/Microsoft.OpenApi.Workbench/Microsoft.OpenApi.Workbench.csproj b/src/Microsoft.OpenApi.Workbench/Microsoft.OpenApi.Workbench.csproj
index d6ae3260e..d15de65eb 100644
--- a/src/Microsoft.OpenApi.Workbench/Microsoft.OpenApi.Workbench.csproj
+++ b/src/Microsoft.OpenApi.Workbench/Microsoft.OpenApi.Workbench.csproj
@@ -10,7 +10,7 @@
all
-
Microsoft
Microsoft.OpenApi
Microsoft.OpenApi
- 1.6.4
+ 1.6.5
.NET models with JSON and YAML writers for OpenAPI specification
© Microsoft Corporation. All rights reserved.
OpenAPI .NET
diff --git a/src/Microsoft.OpenApi/Models/OpenApiDocument.cs b/src/Microsoft.OpenApi/Models/OpenApiDocument.cs
index 5177e4f45..c172d84c7 100644
--- a/src/Microsoft.OpenApi/Models/OpenApiDocument.cs
+++ b/src/Microsoft.OpenApi/Models/OpenApiDocument.cs
@@ -504,6 +504,9 @@ internal IOpenApiReferenceable ResolveReference(OpenApiReference reference, bool
case ReferenceType.Callback:
return this.Components.Callbacks[reference.Id];
+ case ReferenceType.Path:
+ return this.Paths[reference.Id];
+
default:
throw new OpenApiException(Properties.SRResource.InvalidReferenceType);
}
diff --git a/src/Microsoft.OpenApi/Models/OpenApiSchema.cs b/src/Microsoft.OpenApi/Models/OpenApiSchema.cs
index 0176ea1d9..b0ac2dbac 100644
--- a/src/Microsoft.OpenApi/Models/OpenApiSchema.cs
+++ b/src/Microsoft.OpenApi/Models/OpenApiSchema.cs
@@ -288,6 +288,7 @@ public OpenApiSchema(OpenApiSchema schema)
ExternalDocs = schema?.ExternalDocs != null ? new(schema?.ExternalDocs) : null;
Deprecated = schema?.Deprecated ?? Deprecated;
Xml = schema?.Xml != null ? new(schema?.Xml) : null;
+ Extensions = schema?.Extensions != null ? new Dictionary(schema.Extensions) : null;
UnresolvedReference = schema?.UnresolvedReference ?? UnresolvedReference;
Reference = schema?.Reference != null ? new(schema?.Reference) : null;
}
diff --git a/src/Microsoft.OpenApi/Models/ReferenceType.cs b/src/Microsoft.OpenApi/Models/ReferenceType.cs
index 6ac0c9ed2..9d8984c96 100644
--- a/src/Microsoft.OpenApi/Models/ReferenceType.cs
+++ b/src/Microsoft.OpenApi/Models/ReferenceType.cs
@@ -58,6 +58,11 @@ public enum ReferenceType
///
/// Tags item.
///
- [Display("tags")] Tag
+ [Display("tags")] Tag,
+
+ ///
+ /// Paths item.
+ ///
+ [Display("paths")] Path
}
}
diff --git a/src/Microsoft.OpenApi/Properties/SRResource.Designer.cs b/src/Microsoft.OpenApi/Properties/SRResource.Designer.cs
index 96c0ce501..2b1fc7542 100644
--- a/src/Microsoft.OpenApi/Properties/SRResource.Designer.cs
+++ b/src/Microsoft.OpenApi/Properties/SRResource.Designer.cs
@@ -19,7 +19,7 @@ namespace Microsoft.OpenApi.Properties {
// class via a tool like ResGen or Visual Studio.
// To add or remove a member, edit your .ResX file then rerun ResGen
// with the /str option, or rebuild your VS project.
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "16.0.0.0")]
+ [global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "17.0.0.0")]
[global::System.Diagnostics.DebuggerNonUserCodeAttribute()]
[global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()]
internal class SRResource {
@@ -78,6 +78,15 @@ internal static string ArgumentNullOrWhiteSpace {
}
}
+ ///
+ /// Looks up a localized string similar to http://localhost/.
+ ///
+ internal static string DefaultBaseUri {
+ get {
+ return ResourceManager.GetString("DefaultBaseUri", resourceCulture);
+ }
+ }
+
///
/// Looks up a localized string similar to The filed name '{0}' of extension doesn't begin with x-..
///
diff --git a/src/Microsoft.OpenApi/Properties/SRResource.resx b/src/Microsoft.OpenApi/Properties/SRResource.resx
index b2f129be2..3e6822ce4 100644
--- a/src/Microsoft.OpenApi/Properties/SRResource.resx
+++ b/src/Microsoft.OpenApi/Properties/SRResource.resx
@@ -123,6 +123,9 @@
The argument '{0}' is null, empty or consists only of white-space.
+
+ http://localhost/
+
The filed name '{0}' of extension doesn't begin with x-.
diff --git a/src/Microsoft.OpenApi/Services/CopyReferences.cs b/src/Microsoft.OpenApi/Services/CopyReferences.cs
index 24dcfee25..6307ed072 100644
--- a/src/Microsoft.OpenApi/Services/CopyReferences.cs
+++ b/src/Microsoft.OpenApi/Services/CopyReferences.cs
@@ -52,6 +52,16 @@ public override void Visit(IOpenApiReferenceable referenceable)
}
break;
+ case OpenApiRequestBody requestBody:
+ EnsureComponentsExists();
+ EnsureResponsesExists();
+ EnsurRequestBodiesExists();
+ if (!Components.RequestBodies.ContainsKey(requestBody.Reference.Id))
+ {
+ Components.RequestBodies.Add(requestBody.Reference.Id, requestBody);
+ }
+ break;
+
default:
break;
}
@@ -108,5 +118,10 @@ private void EnsureResponsesExists()
_target.Components.Responses = new Dictionary();
}
}
+
+ private void EnsurRequestBodiesExists()
+ {
+ _target.Components.RequestBodies ??= new Dictionary();
+ }
}
}
diff --git a/src/Microsoft.OpenApi/Services/OpenApiFilterService.cs b/src/Microsoft.OpenApi/Services/OpenApiFilterService.cs
index 7b9df3d0e..5de121380 100644
--- a/src/Microsoft.OpenApi/Services/OpenApiFilterService.cs
+++ b/src/Microsoft.OpenApi/Services/OpenApiFilterService.cs
@@ -3,9 +3,11 @@
using System;
using System.Collections.Generic;
+using System.Diagnostics;
using System.Linq;
using System.Text.RegularExpressions;
using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi.Properties;
namespace Microsoft.OpenApi.Services
{
@@ -22,89 +24,26 @@ public static class OpenApiFilterService
/// A predicate.
- public static Func CreatePredicate(string operationIds = null,
- string tags = null, Dictionary> requestUrls = null, OpenApiDocument source = null)
+ public static Func CreatePredicate(
+ string operationIds = null,
+ string tags = null,
+ Dictionary> requestUrls = null,
+ OpenApiDocument source = null)
{
Func predicate;
-
- if (requestUrls != null && (operationIds != null || tags != null))
- {
- throw new InvalidOperationException("Cannot filter by Postman collection and either operationIds and tags at the same time.");
- }
- if (!string.IsNullOrEmpty(operationIds) && !string.IsNullOrEmpty(tags))
- {
- throw new InvalidOperationException("Cannot specify both operationIds and tags at the same time.");
- }
+ ValidateFilters(requestUrls, operationIds, tags);
if (operationIds != null)
{
- if (operationIds == "*")
- {
- predicate = (url, operationType, operation) => true; // All operations
- }
- else
- {
- var operationIdsArray = operationIds.Split(',');
- predicate = (url, operationType, operation) => operationIdsArray.Contains(operation.OperationId);
- }
+ predicate = GetOperationIdsPredicate(operationIds);
}
else if (tags != null)
{
- var tagsArray = tags.Split(',');
- if (tagsArray.Length == 1)
- {
- var regex = new Regex(tagsArray[0]);
-
- predicate = (url, operationType, operation) => operation.Tags.Any(tag => regex.IsMatch(tag.Name));
- }
- else
- {
- predicate = (url, operationType, operation) => operation.Tags.Any(tag => tagsArray.Contains(tag.Name));
- }
+ predicate = GetTagsPredicate(tags);
}
else if (requestUrls != null)
{
- var operationTypes = new List();
-
- if (source != null)
- {
- var apiVersion = source.Info.Version;
-
- var sources = new Dictionary {{ apiVersion, source}};
- var rootNode = CreateOpenApiUrlTreeNode(sources);
-
- // Iterate through urls dictionary and fetch operations for each url
- foreach (var url in requestUrls)
- {
- var serverList = source.Servers;
- var path = ExtractPath(url.Key, serverList);
-
- var openApiOperations = GetOpenApiOperations(rootNode, path, apiVersion);
- if (openApiOperations == null)
- {
- Console.WriteLine($"The url {url.Key} could not be found in the OpenApi description");
- continue;
- }
-
- // Add the available ops if they are in the postman collection. See path.Value
- foreach (var ops in openApiOperations)
- {
- if (url.Value.Contains(ops.Key.ToString().ToUpper()))
- {
- operationTypes.Add(ops.Key + path);
- }
- }
- }
- }
-
- if (!operationTypes.Any())
- {
- throw new ArgumentException("The urls in the Postman collection supplied could not be found.");
- }
-
- // predicate for matching url and operationTypes
- predicate = (path, operationType, operation) => operationTypes.Contains(operationType + path);
+ predicate = GetRequestUrlsPredicate(requestUrls, source);
}
-
else
{
throw new InvalidOperationException("Either operationId(s),tag(s) or Postman collection need to be specified.");
@@ -135,7 +74,7 @@ public static OpenApiDocument CreateFilteredDocument(OpenApiDocument source, Fun
Extensions = source.Info.Extensions
},
- Components = new OpenApiComponents {SecuritySchemes = source.Components.SecuritySchemes},
+ Components = new OpenApiComponents { SecuritySchemes = source.Components.SecuritySchemes },
SecurityRequirements = source.SecurityRequirements,
Servers = source.Servers
};
@@ -199,7 +138,7 @@ public static OpenApiUrlTreeNode CreateOpenApiUrlTreeNode(Dictionary GetOpenApiOperations(OpenApiUrlTreeNode rootNode, string relativeUrl, string label)
{
if (relativeUrl.Equals("/", StringComparison.Ordinal) && rootNode.HasOperations(label))
@@ -328,25 +267,105 @@ private static bool AddReferences(OpenApiComponents newComponents, OpenApiCompon
target.Responses.Add(item);
}
}
+
+ foreach (var item in newComponents.RequestBodies
+ .Where(item => !target.RequestBodies.ContainsKey(item.Key)))
+ {
+ moreStuff = true;
+ target.RequestBodies.Add(item);
+ }
return moreStuff;
}
private static string ExtractPath(string url, IList serverList)
{
- var queryPath = string.Empty;
- foreach (var server in serverList)
+ // if OpenAPI has servers, then see if the url matches one of them
+ var baseUrl = serverList.Select(s => s.Url.TrimEnd('/'))
+ .FirstOrDefault(c => url.Contains(c));
+
+ return baseUrl == null ?
+ new Uri(new Uri(SRResource.DefaultBaseUri), url).GetComponents(UriComponents.Path | UriComponents.KeepDelimiter, UriFormat.Unescaped)
+ : url.Split(new[] { baseUrl }, StringSplitOptions.None)[1];
+ }
+
+ private static void ValidateFilters(IDictionary> requestUrls, string operationIds, string tags)
+ {
+ if (requestUrls != null && (operationIds != null || tags != null))
+ {
+ throw new InvalidOperationException("Cannot filter by Postman collection and either operationIds and tags at the same time.");
+ }
+ if (!string.IsNullOrEmpty(operationIds) && !string.IsNullOrEmpty(tags))
+ {
+ throw new InvalidOperationException("Cannot specify both operationIds and tags at the same time.");
+ }
+ }
+
+ private static Func GetOperationIdsPredicate(string operationIds)
+ {
+ if (operationIds == "*")
+ {
+ return (url, operationType, operation) => true; // All operations
+ }
+ else
+ {
+ var operationIdsArray = operationIds.Split(',');
+ return (url, operationType, operation) => operationIdsArray.Contains(operation.OperationId);
+ }
+ }
+
+ private static Func GetTagsPredicate(string tags)
+ {
+ var tagsArray = tags.Split(',');
+ if (tagsArray.Length == 1)
+ {
+ var regex = new Regex(tagsArray[0]);
+ return (url, operationType, operation) => operation.Tags.Any(tag => regex.IsMatch(tag.Name));
+ }
+ else
+ {
+ return (url, operationType, operation) => operation.Tags.Any(tag => tagsArray.Contains(tag.Name));
+ }
+ }
+
+ private static Func GetRequestUrlsPredicate(Dictionary> requestUrls, OpenApiDocument source)
+ {
+ var operationTypes = new List();
+ if (source != null)
{
- var serverUrl = server.Url.TrimEnd('/');
- if (!url.Contains(serverUrl))
+ var apiVersion = source.Info.Version;
+ var sources = new Dictionary { { apiVersion, source } };
+ var rootNode = CreateOpenApiUrlTreeNode(sources);
+
+ // Iterate through urls dictionary and fetch operations for each url
+ foreach (var url in requestUrls)
{
- continue;
+ var serverList = source.Servers;
+ var path = ExtractPath(url.Key, serverList);
+ var openApiOperations = GetOpenApiOperations(rootNode, path, apiVersion);
+ if (openApiOperations == null)
+ {
+ Debug.WriteLine($"The url {url.Key} could not be found in the OpenApi description");
+ continue;
+ }
+ operationTypes.AddRange(GetOperationTypes(openApiOperations, url.Value, path));
}
+ }
- var urlComponents = url.Split(new[]{ serverUrl }, StringSplitOptions.None);
- queryPath = urlComponents[1];
+ if (!operationTypes.Any())
+ {
+ throw new ArgumentException("The urls in the Postman collection supplied could not be found.");
}
- return queryPath;
+ // predicate for matching url and operationTypes
+ return (path, operationType, operation) => operationTypes.Contains(operationType + path);
+ }
+
+ private static List GetOperationTypes(IDictionary openApiOperations, List url, string path)
+ {
+ // Add the available ops if they are in the postman collection. See path.Value
+ return openApiOperations.Where(ops => url.Contains(ops.Key.ToString().ToUpper()))
+ .Select(ops => ops.Key + path)
+ .ToList();
}
}
}
diff --git a/src/Microsoft.OpenApi/Services/OpenApiWalker.cs b/src/Microsoft.OpenApi/Services/OpenApiWalker.cs
index 3d9e978c9..1da6cc9cf 100644
--- a/src/Microsoft.OpenApi/Services/OpenApiWalker.cs
+++ b/src/Microsoft.OpenApi/Services/OpenApiWalker.cs
@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.
using System;
@@ -447,7 +447,8 @@ internal void Walk(OpenApiPathItem pathItem)
_visitor.Visit(pathItem);
- if (pathItem != null)
+ // The path may be a reference
+ if (pathItem != null && !ProcessAsReference(pathItem))
{
Walk(OpenApiConstants.Parameters, () => Walk(pathItem.Parameters));
Walk(pathItem.Operations);
diff --git a/test/Microsoft.OpenApi.Hidi.Tests/Formatters/PowerShellFormatterTests.cs b/test/Microsoft.OpenApi.Hidi.Tests/Formatters/PowerShellFormatterTests.cs
new file mode 100644
index 000000000..a22348897
--- /dev/null
+++ b/test/Microsoft.OpenApi.Hidi.Tests/Formatters/PowerShellFormatterTests.cs
@@ -0,0 +1,184 @@
+using Microsoft.OpenApi.Any;
+using Microsoft.OpenApi.Hidi.Formatters;
+using Microsoft.OpenApi.Interfaces;
+using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi.Services;
+using Xunit;
+
+namespace Microsoft.OpenApi.Hidi.Tests.Formatters
+{
+ public class PowerShellFormatterTests
+ {
+ [Theory]
+ [InlineData("drives.drive.ListDrive", "drive_ListDrive", OperationType.Get)]
+ [InlineData("print.taskDefinitions.tasks.GetTrigger", "print.taskDefinition.task_GetTrigger", OperationType.Get)]
+ [InlineData("groups.sites.termStore.groups.GetSets", "group.site.termStore.group_GetSet", OperationType.Get)]
+ [InlineData("external.industryData.ListDataConnectors", "external.industryData_ListDataConnector", OperationType.Get)]
+ [InlineData("applications.application.UpdateLogo", "application_SetLogo", OperationType.Put)]
+ [InlineData("identityGovernance.lifecycleWorkflows.workflows.workflow.activate", "identityGovernance.lifecycleWorkflow.workflow_activate", OperationType.Post)]
+ [InlineData("directory.GetDeletedItems.AsApplication", "directory_GetDeletedItemAsApplication", OperationType.Get)]
+ [InlineData("education.users.GetCount-6be9", "education.user_GetCount", OperationType.Get)]
+ public void FormatOperationIdsInOpenAPIDocument(string operationId, string expectedOperationId, OperationType operationType, string path = "/foo")
+ {
+ // Arrange
+ var openApiDocument = new OpenApiDocument()
+ {
+ Info = new() { Title = "Test", Version = "1.0" },
+ Servers = new List() { new() { Url = "https://localhost/" } },
+ Paths = new()
+ {
+ { path, new() {
+ Operations = new Dictionary() {
+ { operationType, new() { OperationId = operationId } }
+ }
+ }
+ }
+ }
+ };
+
+ // Act
+ var powerShellFormatter = new PowerShellFormatter();
+ var walker = new OpenApiWalker(powerShellFormatter);
+ walker.Walk(openApiDocument);
+
+ // Assert
+ Assert.Equal(expectedOperationId, openApiDocument.Paths[path].Operations[operationType].OperationId);
+ }
+
+ [Fact]
+ public void RemoveAnyOfAndOneOfFromSchema()
+ {
+ // Arrange
+ var openApiDocument = GetSampleOpenApiDocument();
+
+ // Act
+ var powerShellFormatter = new PowerShellFormatter();
+ var walker = new OpenApiWalker(powerShellFormatter);
+ walker.Walk(openApiDocument);
+
+ var testSchema = openApiDocument.Components.Schemas["TestSchema"];
+ var averageAudioDegradationProperty = testSchema.Properties["averageAudioDegradation"];
+ var defaultPriceProperty = testSchema.Properties["defaultPrice"];
+
+ // Assert
+ Assert.Null(averageAudioDegradationProperty.AnyOf);
+ Assert.Equal("number", averageAudioDegradationProperty.Type);
+ Assert.Equal("float", averageAudioDegradationProperty.Format);
+ Assert.True(averageAudioDegradationProperty.Nullable);
+ Assert.Null(defaultPriceProperty.OneOf);
+ Assert.Equal("number", defaultPriceProperty.Type);
+ Assert.Equal("double", defaultPriceProperty.Format);
+ Assert.NotNull(testSchema.AdditionalProperties);
+ }
+
+ [Fact]
+ public void ResolveFunctionParameters()
+ {
+ // Arrange
+ var openApiDocument = GetSampleOpenApiDocument();
+
+ // Act
+ var powerShellFormatter = new PowerShellFormatter();
+ var walker = new OpenApiWalker(powerShellFormatter);
+ walker.Walk(openApiDocument);
+
+ var idsParameter = openApiDocument.Paths["/foo"].Operations[OperationType.Get].Parameters.Where(static p => p.Name == "ids").FirstOrDefault();
+
+ // Assert
+ Assert.Null(idsParameter?.Content);
+ Assert.NotNull(idsParameter?.Schema);
+ Assert.Equal("array", idsParameter?.Schema.Type);
+ }
+
+ private static OpenApiDocument GetSampleOpenApiDocument()
+ {
+ return new OpenApiDocument()
+ {
+ Info = new() { Title = "Test", Version = "1.0" },
+ Servers = new List() { new() { Url = "https://localhost/" } },
+ Paths = new() {
+ { "/foo", new()
+ {
+ Operations = new Dictionary()
+ {
+ {
+ OperationType.Get, new()
+ {
+ OperationId = "Foo.GetFoo",
+ Parameters = new List
+ {
+ new OpenApiParameter()
+ {
+ Name = "ids",
+ In = ParameterLocation.Query,
+ Content = new Dictionary
+ {
+ {
+ "application/json",
+ new OpenApiMediaType
+ {
+ Schema = new OpenApiSchema
+ {
+ Type = "array",
+ Items = new OpenApiSchema
+ {
+ Type = "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ Extensions = new Dictionary
+ {
+ {
+ "x-ms-docs-operation-type", new OpenApiString("function")
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ Components = new()
+ {
+ Schemas = new Dictionary
+ {
+ { "TestSchema", new OpenApiSchema
+ {
+ Type = "object",
+ Properties = new Dictionary
+ {
+ {
+ "averageAudioDegradation", new OpenApiSchema
+ {
+ AnyOf = new List
+ {
+ new OpenApiSchema { Type = "number" },
+ new OpenApiSchema { Type = "string" }
+ },
+ Format = "float",
+ Nullable = true
+ }
+ },
+ {
+ "defaultPrice", new OpenApiSchema
+ {
+ OneOf = new List
+ {
+ new OpenApiSchema { Type = "number", Format = "double" },
+ new OpenApiSchema { Type = "string" }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ };
+ }
+ }
+}
diff --git a/test/Microsoft.OpenApi.Hidi.Tests/Microsoft.OpenApi.Hidi.Tests.csproj b/test/Microsoft.OpenApi.Hidi.Tests/Microsoft.OpenApi.Hidi.Tests.csproj
index f9b1a0f2c..87fade6cd 100644
--- a/test/Microsoft.OpenApi.Hidi.Tests/Microsoft.OpenApi.Hidi.Tests.csproj
+++ b/test/Microsoft.OpenApi.Hidi.Tests/Microsoft.OpenApi.Hidi.Tests.csproj
@@ -1,4 +1,4 @@
-
+
net7.0
@@ -9,18 +9,18 @@
-
+
runtime; build; native; contentfiles; analyzers; buildtransitive
all
-
runtime; build; native; contentfiles; analyzers; buildtransitive
all
-
+
runtime; build; native; contentfiles; analyzers; buildtransitive
all
@@ -59,6 +59,12 @@
Always
+
+ Always
+
+
+ Always
+
diff --git a/test/Microsoft.OpenApi.Hidi.Tests/Services/OpenApiFilterServiceTests.cs b/test/Microsoft.OpenApi.Hidi.Tests/Services/OpenApiFilterServiceTests.cs
index 176fb20d1..3733ad848 100644
--- a/test/Microsoft.OpenApi.Hidi.Tests/Services/OpenApiFilterServiceTests.cs
+++ b/test/Microsoft.OpenApi.Hidi.Tests/Services/OpenApiFilterServiceTests.cs
@@ -1,28 +1,25 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.
-using System;
-using System.IO;
using Microsoft.Extensions.Logging;
-using Microsoft.OpenApi.Hidi;
using Microsoft.OpenApi.Models;
using Microsoft.OpenApi.Services;
using Microsoft.OpenApi.Tests.UtilityFiles;
using Moq;
using Xunit;
-namespace Microsoft.OpenApi.Tests.Services
+namespace Microsoft.OpenApi.Hidi.Tests
{
public class OpenApiFilterServiceTests
{
private readonly OpenApiDocument _openApiDocumentMock;
- private readonly Mock> _mockLogger;
- private readonly ILogger _logger;
+ private readonly Mock> _mockLogger;
+ private readonly ILogger _logger;
public OpenApiFilterServiceTests()
{
_openApiDocumentMock = OpenApiDocumentMock.CreateOpenApiDocument();
- _mockLogger = new Mock>();
+ _mockLogger = new Mock>();
_logger = _mockLogger.Object;
}
@@ -69,6 +66,43 @@ public void ReturnFilteredOpenApiDocumentBasedOnPostmanCollection()
Assert.Equal(3, subsetOpenApiDocument.Paths.Count);
}
+ // Create predicate based RequestUrls
+ [Fact]
+ public void TestPredicateFiltersUsingRelativeRequestUrls()
+ {
+ var openApiDocument = new OpenApiDocument()
+ {
+ Info = new() { Title = "Test", Version = "1.0" },
+ Servers = new List() { new() { Url = "https://localhost/" } },
+ Paths = new()
+ {
+ {"/foo", new() {
+ Operations = new Dictionary() {
+ { OperationType.Get, new() },
+ { OperationType.Patch, new() },
+ { OperationType.Post, new() }
+ }
+ }
+ }
+ }
+ };
+
+ // Given a set of RequestUrls
+ var requestUrls = new Dictionary>
+ {
+ {"/foo", new List {"GET","POST"}}
+ };
+
+ // When
+ var predicate = OpenApiFilterService.CreatePredicate(requestUrls: requestUrls, source: openApiDocument);
+
+ // Then
+ Assert.True(predicate("/foo", OperationType.Get, null));
+ Assert.True(predicate("/foo", OperationType.Post, null));
+ Assert.False(predicate("/foo", OperationType.Patch, null));
+ }
+
+
[Fact]
public void ShouldParseNestedPostmanCollection()
{
diff --git a/test/Microsoft.OpenApi.Hidi.Tests/Services/OpenApiServiceTests.cs b/test/Microsoft.OpenApi.Hidi.Tests/Services/OpenApiServiceTests.cs
index 9081c49f5..c092da510 100644
--- a/test/Microsoft.OpenApi.Hidi.Tests/Services/OpenApiServiceTests.cs
+++ b/test/Microsoft.OpenApi.Hidi.Tests/Services/OpenApiServiceTests.cs
@@ -3,22 +3,29 @@
using System.CommandLine;
using System.CommandLine.Invocation;
-using System.Text;
-using Castle.Core.Logging;
+using System.CommandLine.Parsing;
+using System.Text.Json;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Logging;
-using Microsoft.OpenApi.Hidi;
-using Microsoft.OpenApi.Hidi.Handlers;
+using Microsoft.OpenApi.ApiManifest.OpenAI;
+using Microsoft.OpenApi.Hidi.Options;
+using Microsoft.OpenApi.Hidi.Utilities;
using Microsoft.OpenApi.Models;
using Microsoft.OpenApi.OData;
using Microsoft.OpenApi.Services;
-using Microsoft.VisualStudio.TestPlatform.Utilities;
using Xunit;
-namespace Microsoft.OpenApi.Tests.Services
+namespace Microsoft.OpenApi.Hidi.Tests
{
public class OpenApiServiceTests
{
+ private readonly ILogger _logger;
+
+ public OpenApiServiceTests()
+ {
+ _logger = new Logger(new LoggerFactory());
+ }
+
[Fact]
public async Task ReturnConvertedCSDLFile()
{
@@ -26,7 +33,6 @@ public async Task ReturnConvertedCSDLFile()
var filePath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "UtilityFiles\\Todo.xml");
var fileInput = new FileInfo(filePath);
var csdlStream = fileInput.OpenRead();
-
// Act
var openApiDoc = await OpenApiService.ConvertCsdlToOpenApi(csdlStream);
var expectedPathCount = 5;
@@ -36,7 +42,7 @@ public async Task ReturnConvertedCSDLFile()
Assert.NotEmpty(openApiDoc.Paths);
Assert.Equal(expectedPathCount, openApiDoc.Paths.Count);
}
-
+
[Theory]
[InlineData("Todos.Todo.UpdateTodo", null, 1)]
[InlineData("Todos.Todo.ListTodo", null, 1)]
@@ -47,7 +53,7 @@ public async Task ReturnFilteredOpenApiDocBasedOnOperationIdsAndInputCsdlDocumen
var filePath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "UtilityFiles\\Todo.xml");
var fileInput = new FileInfo(filePath);
var csdlStream = fileInput.OpenRead();
-
+
// Act
var openApiDoc = await OpenApiService.ConvertCsdlToOpenApi(csdlStream);
var predicate = OpenApiFilterService.CreatePredicate(operationIds, tags);
@@ -58,14 +64,14 @@ public async Task ReturnFilteredOpenApiDocBasedOnOperationIdsAndInputCsdlDocumen
Assert.NotEmpty(subsetOpenApiDocument.Paths);
Assert.Equal(expectedPathCount, subsetOpenApiDocument.Paths.Count);
}
-
+
[Theory]
[InlineData("UtilityFiles/appsettingstest.json")]
[InlineData(null)]
public void ReturnOpenApiConvertSettingsWhenSettingsFileIsProvided(string filePath)
{
// Arrange
- var config = OpenApiService.GetConfiguration(filePath);
+ var config = SettingsUtilities.GetConfiguration(filePath);
// Act and Assert
var settings = config.GetSection("OpenApiConvertSettings").Get();
@@ -122,34 +128,50 @@ public void ShowCommandGeneratesMermaidDiagramAsHtml()
var output = reader.ReadToEnd();
Assert.Contains("graph LR", output);
}
-
+
[Fact]
public async Task ShowCommandGeneratesMermaidMarkdownFileWithMermaidDiagram()
{
- var fileinfo = new FileInfo("sample.md");
+
// create a dummy ILogger instance for testing
- await OpenApiService.ShowOpenApiDocument("UtilityFiles\\SampleOpenApi.yml", null, null, fileinfo, new Logger(new LoggerFactory()), new CancellationToken());
+ var options = new HidiOptions()
+ {
+ OpenApi = "UtilityFiles\\SampleOpenApi.yml",
+ Output = new FileInfo("sample.md")
+ };
+
+ await OpenApiService.ShowOpenApiDocument(options, _logger, new CancellationToken());
- var output = File.ReadAllText(fileinfo.FullName);
+ var output = File.ReadAllText(options.Output.FullName);
Assert.Contains("graph LR", output);
}
[Fact]
public async Task ShowCommandGeneratesMermaidHtmlFileWithMermaidDiagram()
{
- var filePath = await OpenApiService.ShowOpenApiDocument("UtilityFiles\\SampleOpenApi.yml", null, null, null, new Logger(new LoggerFactory()), new CancellationToken());
+ var options = new HidiOptions()
+ {
+ OpenApi = "UtilityFiles\\SampleOpenApi.yml"
+ };
+ var filePath = await OpenApiService.ShowOpenApiDocument(options, _logger, new CancellationToken());
Assert.True(File.Exists(filePath));
}
[Fact]
public async Task ShowCommandGeneratesMermaidMarkdownFileFromCsdlWithMermaidDiagram()
{
- var fileinfo = new FileInfo("sample.md");
+ var options = new HidiOptions()
+ {
+ Csdl = "UtilityFiles\\Todo.xml",
+ CsdlFilter = "todos",
+ Output = new FileInfo("sample.md")
+ };
+
// create a dummy ILogger instance for testing
- await OpenApiService.ShowOpenApiDocument(null, "UtilityFiles\\Todo.xml", "todos", fileinfo, new Logger(new LoggerFactory()), new CancellationToken());
+ await OpenApiService.ShowOpenApiDocument(options, _logger, new CancellationToken());
- var output = File.ReadAllText(fileinfo.FullName);
+ var output = File.ReadAllText(options.Output.FullName);
Assert.Contains("graph LR", output);
}
@@ -157,7 +179,7 @@ public async Task ShowCommandGeneratesMermaidMarkdownFileFromCsdlWithMermaidDiag
public async Task ThrowIfOpenApiUrlIsNotProvidedWhenValidating()
{
await Assert.ThrowsAsync(async () =>
- await OpenApiService.ValidateOpenApiDocument("", new Logger(new LoggerFactory()), new CancellationToken()));
+ await OpenApiService.ValidateOpenApiDocument("", _logger, new CancellationToken()));
}
@@ -165,21 +187,21 @@ await Assert.ThrowsAsync(async () =>
public async Task ThrowIfURLIsNotResolvableWhenValidating()
{
await Assert.ThrowsAsync(async () =>
- await OpenApiService.ValidateOpenApiDocument("https://example.org/itdoesnmatter", new Logger(new LoggerFactory()), new CancellationToken()));
+ await OpenApiService.ValidateOpenApiDocument("https://example.org/itdoesnmatter", _logger, new CancellationToken()));
}
[Fact]
public async Task ThrowIfFileDoesNotExistWhenValidating()
{
await Assert.ThrowsAsync(async () =>
- await OpenApiService.ValidateOpenApiDocument("aFileThatBetterNotExist.fake", new Logger(new LoggerFactory()), new CancellationToken()));
+ await OpenApiService.ValidateOpenApiDocument("aFileThatBetterNotExist.fake", _logger, new CancellationToken()));
}
[Fact]
public async Task ValidateCommandProcessesOpenApi()
{
// create a dummy ILogger instance for testing
- await OpenApiService.ValidateOpenApiDocument("UtilityFiles\\SampleOpenApi.yml", new Logger(new LoggerFactory()), new CancellationToken());
+ await OpenApiService.ValidateOpenApiDocument("UtilityFiles\\SampleOpenApi.yml", _logger, new CancellationToken());
Assert.True(true);
}
@@ -188,20 +210,36 @@ public async Task ValidateCommandProcessesOpenApi()
[Fact]
public async Task TransformCommandConvertsOpenApi()
{
- var fileinfo = new FileInfo("sample.json");
+ HidiOptions options = new HidiOptions
+ {
+ OpenApi = "UtilityFiles\\SampleOpenApi.yml",
+ Output = new FileInfo("sample.json"),
+ CleanOutput = true,
+ TerseOutput = false,
+ InlineLocal = false,
+ InlineExternal = false,
+ };
// create a dummy ILogger instance for testing
- await OpenApiService.TransformOpenApiDocument("UtilityFiles\\SampleOpenApi.yml",null, null, fileinfo, true, null, null, null,false,null,false,false,null,null,null,new Logger(new LoggerFactory()), new CancellationToken());
+ await OpenApiService.TransformOpenApiDocument(options, _logger, new CancellationToken());
var output = File.ReadAllText("sample.json");
Assert.NotEmpty(output);
}
-
+
[Fact]
public async Task TransformCommandConvertsOpenApiWithDefaultOutputname()
{
+ HidiOptions options = new HidiOptions
+ {
+ OpenApi = "UtilityFiles\\SampleOpenApi.yml",
+ CleanOutput = true,
+ TerseOutput = false,
+ InlineLocal = false,
+ InlineExternal = false,
+ };
// create a dummy ILogger instance for testing
- await OpenApiService.TransformOpenApiDocument("UtilityFiles\\SampleOpenApi.yml", null, null, null, true, null, null, null, false, null, false, false, null, null, null, new Logger(new LoggerFactory()), new CancellationToken());
+ await OpenApiService.TransformOpenApiDocument(options, _logger, new CancellationToken());
var output = File.ReadAllText("output.yml");
Assert.NotEmpty(output);
@@ -210,8 +248,16 @@ public async Task TransformCommandConvertsOpenApiWithDefaultOutputname()
[Fact]
public async Task TransformCommandConvertsCsdlWithDefaultOutputname()
{
+ HidiOptions options = new HidiOptions
+ {
+ Csdl = "UtilityFiles\\Todo.xml",
+ CleanOutput = true,
+ TerseOutput = false,
+ InlineLocal = false,
+ InlineExternal = false,
+ };
// create a dummy ILogger instance for testing
- await OpenApiService.TransformOpenApiDocument(null, "UtilityFiles\\Todo.xml", null, null, true, null, null, null, false, null, false, false, null, null, null, new Logger(new LoggerFactory()), new CancellationToken());
+ await OpenApiService.TransformOpenApiDocument(options, _logger, new CancellationToken());
var output = File.ReadAllText("output.yml");
Assert.NotEmpty(output);
@@ -220,8 +266,18 @@ public async Task TransformCommandConvertsCsdlWithDefaultOutputname()
[Fact]
public async Task TransformCommandConvertsOpenApiWithDefaultOutputnameAndSwitchFormat()
{
+ HidiOptions options = new HidiOptions
+ {
+ OpenApi = "UtilityFiles\\SampleOpenApi.yml",
+ CleanOutput = true,
+ Version = "3.0",
+ OpenApiFormat = OpenApiFormat.Yaml,
+ TerseOutput = false,
+ InlineLocal = false,
+ InlineExternal = false,
+ };
// create a dummy ILogger instance for testing
- await OpenApiService.TransformOpenApiDocument("UtilityFiles\\SampleOpenApi.yml", null, null, null, true, "3.0", null, OpenApiFormat.Yaml, false, null, false, false, null, null, null, new Logger(new LoggerFactory()), new CancellationToken());
+ await OpenApiService.TransformOpenApiDocument(options, _logger, new CancellationToken());
var output = File.ReadAllText("output.yml");
Assert.NotEmpty(output);
@@ -230,21 +286,50 @@ public async Task TransformCommandConvertsOpenApiWithDefaultOutputnameAndSwitchF
[Fact]
public async Task ThrowTransformCommandIfOpenApiAndCsdlAreEmpty()
{
+ HidiOptions options = new HidiOptions
+ {
+ CleanOutput = true,
+ TerseOutput = false,
+ InlineLocal = false,
+ InlineExternal = false,
+ };
await Assert.ThrowsAsync(async () =>
- await OpenApiService.TransformOpenApiDocument(null, null, null, null, true, null, null, null, false, null, false, false, null, null, null, new Logger(new LoggerFactory()), new CancellationToken()));
+ await OpenApiService.TransformOpenApiDocument(options, _logger, new CancellationToken()));
+
+ }
+
+ [Fact]
+ public async Task TransformToPowerShellCompliantOpenApi()
+ {
+ var settingsPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "UtilityFiles\\examplepowershellsettings.json");
+ HidiOptions options = new HidiOptions
+ {
+ OpenApi = "UtilityFiles\\SampleOpenApi.yml",
+ CleanOutput = true,
+ Version = "3.0",
+ OpenApiFormat = OpenApiFormat.Yaml,
+ TerseOutput = false,
+ InlineLocal = false,
+ InlineExternal = false,
+ SettingsConfig = SettingsUtilities.GetConfiguration(settingsPath)
+ };
+ // create a dummy ILogger instance for testing
+ await OpenApiService.TransformOpenApiDocument(options, _logger, new CancellationToken());
+ var output = File.ReadAllText("output.yml");
+ Assert.NotEmpty(output);
}
[Fact]
public void InvokeTransformCommand()
{
var rootCommand = Program.CreateRootCommand();
- var args = new string[] { "transform", "-d", ".\\UtilityFiles\\SampleOpenApi.yml", "-o", "sample.json","--co" };
+ var args = new string[] { "transform", "-d", ".\\UtilityFiles\\SampleOpenApi.yml", "-o", "sample.json", "--co" };
var parseResult = rootCommand.Parse(args);
var handler = rootCommand.Subcommands.Where(c => c.Name == "transform").First().Handler;
var context = new InvocationContext(parseResult);
- handler.Invoke(context);
+ handler!.Invoke(context);
var output = File.ReadAllText("sample.json");
Assert.NotEmpty(output);
@@ -260,12 +345,31 @@ public void InvokeShowCommand()
var handler = rootCommand.Subcommands.Where(c => c.Name == "show").First().Handler;
var context = new InvocationContext(parseResult);
- handler.Invoke(context);
+ handler!.Invoke(context);
var output = File.ReadAllText("sample.md");
Assert.Contains("graph LR", output);
}
+ [Fact]
+ public void InvokePluginCommand()
+ {
+ var rootCommand = Program.CreateRootCommand();
+ var args = new string[] { "plugin", "-m", ".\\UtilityFiles\\exampleapimanifest.json", "--of", AppDomain.CurrentDomain.BaseDirectory };
+ var parseResult = rootCommand.Parse(args);
+ var handler = rootCommand.Subcommands.Where(c => c.Name == "plugin").First().Handler;
+ var context = new InvocationContext(parseResult);
+
+ handler!.Invoke(context);
+
+ using var jsDoc = JsonDocument.Parse(File.ReadAllText("ai-plugin.json"));
+ var openAiManifest = OpenAIPluginManifest.Load(jsDoc.RootElement);
+
+ Assert.Equal("Mastodon - Subset", openAiManifest?.NameForHuman);
+ Assert.Equal("openapi", openAiManifest?.Api.Type);
+ Assert.Equal("./openapi.json", openAiManifest?.Api.Url);
+ }
+
// Relatively useless test to keep the code coverage metrics happy
[Fact]
diff --git a/test/Microsoft.OpenApi.Hidi.Tests/UtilityFiles/SampleOpenApi.yml b/test/Microsoft.OpenApi.Hidi.Tests/UtilityFiles/SampleOpenApi.yml
index c4fb2e62f..e0bfe1d12 100644
--- a/test/Microsoft.OpenApi.Hidi.Tests/UtilityFiles/SampleOpenApi.yml
+++ b/test/Microsoft.OpenApi.Hidi.Tests/UtilityFiles/SampleOpenApi.yml
@@ -5,15 +5,18 @@ info:
paths:
/api/editresource:
get:
+ operationId: api.ListEditresource
responses:
'200':
description: OK
patch:
+ operationId: api.UpdateEditresource
responses:
'200':
description: OK
/api/viewresource:
get:
+ operationId: api.ListViewresource
responses:
'200':
description: OK
\ No newline at end of file
diff --git a/test/Microsoft.OpenApi.Hidi.Tests/UtilityFiles/exampleapimanifest.json b/test/Microsoft.OpenApi.Hidi.Tests/UtilityFiles/exampleapimanifest.json
new file mode 100644
index 000000000..dd9909974
--- /dev/null
+++ b/test/Microsoft.OpenApi.Hidi.Tests/UtilityFiles/exampleapimanifest.json
@@ -0,0 +1,26 @@
+{
+ "publisher": {
+ "name": "Alice",
+ "contactEmail": "alice@example.org"
+ },
+ "apiDependencies": {
+ "moostodon" : {
+ "apiDescripionUrl": "https://raw.githubusercontent.com/APIPatterns/Moostodon/main/spec/tsp-output/%40typespec/openapi3/openapi.yaml",
+ "auth": {
+ "clientIdentifier": "some-uuid-here",
+ "access": [ "resourceA.ReadWrite",
+ "resourceB.ReadWrite","resourceB.Read"]
+ },
+ "requests": [
+ {
+ "method": "GET",
+ "uriTemplate": "/api/v1/accounts/search"
+ },
+ {
+ "method": "GET",
+ "uriTemplate": "/api/v1/accounts/{id}"
+ }
+ ]
+ }
+ }
+}
diff --git a/test/Microsoft.OpenApi.Hidi.Tests/UtilityFiles/examplepowershellsettings.json b/test/Microsoft.OpenApi.Hidi.Tests/UtilityFiles/examplepowershellsettings.json
new file mode 100644
index 000000000..3e7574b4c
--- /dev/null
+++ b/test/Microsoft.OpenApi.Hidi.Tests/UtilityFiles/examplepowershellsettings.json
@@ -0,0 +1,22 @@
+{
+ "OpenApiConvertSettings": {
+ "AddSingleQuotesForStringParameters": true,
+ "AddEnumDescriptionExtension": true,
+ "EnableKeyAsSegment": true,
+ "EnableOperationId": true,
+ "PrefixEntityTypeNameBeforeKey": true,
+ "TagDepth": 2,
+ "EnablePagination": true,
+ "EnableDiscriminatorValue": false,
+ "EnableDerivedTypesReferencesForRequestBody": false,
+ "EnableDerivedTypesReferencesForResponses": false,
+ "ShowRootPath": false,
+ "ExpandDerivedTypesNavigationProperties": false,
+ "ShowLinks": false,
+ "DeclarePathParametersOnPathItem": false,
+ "EnableODataAnnotationReferencesForResponses": false,
+ "EnableODataTypeCast": true,
+ "UseSuccessStatusCodeRange": true
+ },
+ "LanguageFormat": "PowerShell"
+ }
\ No newline at end of file
diff --git a/test/Microsoft.OpenApi.Readers.Tests/Microsoft.OpenApi.Readers.Tests.csproj b/test/Microsoft.OpenApi.Readers.Tests/Microsoft.OpenApi.Readers.Tests.csproj
index bde45294c..97ae2f019 100644
--- a/test/Microsoft.OpenApi.Readers.Tests/Microsoft.OpenApi.Readers.Tests.csproj
+++ b/test/Microsoft.OpenApi.Readers.Tests/Microsoft.OpenApi.Readers.Tests.csproj
@@ -13,6 +13,8 @@
..\..\src\Microsoft.OpenApi.snk
+
+
Never
@@ -256,15 +260,15 @@
-
+
runtime; build; native; contentfiles; analyzers; buildtransitive
all
-
+
runtime; build; native; contentfiles; analyzers; buildtransitive
all
-
diff --git a/test/Microsoft.OpenApi.Readers.Tests/OpenApiReaderTests/OpenApiDiagnosticTests.cs b/test/Microsoft.OpenApi.Readers.Tests/OpenApiReaderTests/OpenApiDiagnosticTests.cs
index 1bcd7b9d9..23c23b4d6 100644
--- a/test/Microsoft.OpenApi.Readers.Tests/OpenApiReaderTests/OpenApiDiagnosticTests.cs
+++ b/test/Microsoft.OpenApi.Readers.Tests/OpenApiReaderTests/OpenApiDiagnosticTests.cs
@@ -1,8 +1,16 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using System;
using FluentAssertions;
+using Microsoft.OpenApi.Exceptions;
+using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi.Readers.Tests.OpenApiWorkspaceTests;
using Xunit;
+using Microsoft.OpenApi.Readers.Interface;
+using System.IO;
namespace Microsoft.OpenApi.Readers.Tests.OpenApiReaderTests
{
@@ -32,5 +40,45 @@ public void DetectedSpecificationVersionShouldBeV3_0()
diagnostic.SpecificationVersion.Should().Be(OpenApiSpecVersion.OpenApi3_0);
}
}
+
+ [Fact]
+ public async Task DiagnosticReportMergedForExternalReference()
+ {
+ // Create a reader that will resolve all references
+ var reader = new OpenApiStreamReader(new OpenApiReaderSettings()
+ {
+ LoadExternalRefs = true,
+ CustomExternalLoader = new ResourceLoader(),
+ BaseUrl = new Uri("fie://c:\\")
+ });
+
+ ReadResult result;
+ using (var stream = Resources.GetStream("OpenApiReaderTests/Samples/OpenApiDiagnosticReportMerged/TodoMain.yaml"))
+ {
+ result = await reader.ReadAsync(stream);
+ }
+
+ Assert.NotNull(result);
+ Assert.NotNull(result.OpenApiDocument.Workspace);
+ Assert.True(result.OpenApiDocument.Workspace.Contains("TodoReference.yaml"));
+ result.OpenApiDiagnostic.Errors.Should().BeEquivalentTo(new List {
+ new OpenApiError( new OpenApiException("[File: ./TodoReference.yaml] Invalid Reference identifier 'object-not-existing'.")) });
+
+ }
+ }
+
+ public class ResourceLoader : IStreamLoader
+ {
+ public Stream Load(Uri uri)
+ {
+ return null;
+ }
+
+ public Task LoadAsync(Uri uri)
+ {
+ var path = new Uri(new Uri("http://example.org/OpenApiReaderTests/Samples/OpenApiDiagnosticReportMerged/"), uri).AbsolutePath;
+ path = path.Substring(1); // remove leading slash
+ return Task.FromResult(Resources.GetStream(path));
+ }
}
}
diff --git a/test/Microsoft.OpenApi.Readers.Tests/OpenApiReaderTests/Samples/OpenApiDiagnosticReportMerged/TodoMain.yaml b/test/Microsoft.OpenApi.Readers.Tests/OpenApiReaderTests/Samples/OpenApiDiagnosticReportMerged/TodoMain.yaml
new file mode 100644
index 000000000..beaa7995c
--- /dev/null
+++ b/test/Microsoft.OpenApi.Readers.Tests/OpenApiReaderTests/Samples/OpenApiDiagnosticReportMerged/TodoMain.yaml
@@ -0,0 +1,16 @@
+openapi: 3.0.1
+info:
+ title: Example using a remote reference
+ version: 1.0.0
+paths:
+ "/todos":
+ get:
+ parameters:
+ - $ref: ./TodoReference.yaml#/components/parameters/filter
+ responses:
+ 200:
+ description: Ok
+ content:
+ application/json:
+ schema:
+ $ref: ./TodoReference.yaml#/components/schemas/todo
\ No newline at end of file
diff --git a/test/Microsoft.OpenApi.Readers.Tests/OpenApiReaderTests/Samples/OpenApiDiagnosticReportMerged/TodoReference.yaml b/test/Microsoft.OpenApi.Readers.Tests/OpenApiReaderTests/Samples/OpenApiDiagnosticReportMerged/TodoReference.yaml
new file mode 100644
index 000000000..db3958149
--- /dev/null
+++ b/test/Microsoft.OpenApi.Readers.Tests/OpenApiReaderTests/Samples/OpenApiDiagnosticReportMerged/TodoReference.yaml
@@ -0,0 +1,26 @@
+openapi: 3.0.1
+info:
+ title: Components for the todo app
+ version: 1.0.0
+paths: {}
+components:
+ parameters:
+ filter:
+ name: filter
+ in: query
+ schema:
+ type: string
+ schemas:
+ todo:
+ type: object
+ allOf:
+ - $ref: "#/components/schemas/entity"
+ - $ref: "#/components/schemas/object-not-existing"
+ properties:
+ subject:
+ type: string
+ entity:
+ type: object
+ properties:
+ id:
+ type:string
\ No newline at end of file
diff --git a/test/Microsoft.OpenApi.Readers.Tests/ReferenceService/ConvertToOpenApiReferenceV3Tests.cs b/test/Microsoft.OpenApi.Readers.Tests/ReferenceService/ConvertToOpenApiReferenceV3Tests.cs
index f7368b09b..6b94a161b 100644
--- a/test/Microsoft.OpenApi.Readers.Tests/ReferenceService/ConvertToOpenApiReferenceV3Tests.cs
+++ b/test/Microsoft.OpenApi.Readers.Tests/ReferenceService/ConvertToOpenApiReferenceV3Tests.cs
@@ -124,5 +124,24 @@ public void ParseLocalFileReference()
reference.Type.Should().Be(referenceType);
reference.ExternalResource.Should().Be(input);
}
+
+ [Fact]
+ public void ParseExternalPathReference()
+ {
+ // Arrange
+ var versionService = new OpenApiV3VersionService(Diagnostic);
+ var externalResource = "externalSchema.json";
+ var referenceJsonEscaped = "/paths/~1applications~1{AppUUID}~1services~1{ServiceName}";
+ var input = $"{externalResource}#{referenceJsonEscaped}";
+ var id = "/applications/{AppUUID}/services/{ServiceName}";
+
+ // Act
+ var reference = versionService.ConvertToOpenApiReference(input, null);
+
+ // Assert
+ reference.Type.Should().BeNull();
+ reference.ExternalResource.Should().Be(externalResource);
+ reference.Id.Should().Be(id);
+ }
}
}
diff --git a/test/Microsoft.OpenApi.SmokeTests/Microsoft.OpenApi.SmokeTests.csproj b/test/Microsoft.OpenApi.SmokeTests/Microsoft.OpenApi.SmokeTests.csproj
index b2820b16a..83cf2fc86 100644
--- a/test/Microsoft.OpenApi.SmokeTests/Microsoft.OpenApi.SmokeTests.csproj
+++ b/test/Microsoft.OpenApi.SmokeTests/Microsoft.OpenApi.SmokeTests.csproj
@@ -1,4 +1,4 @@
-
+
net7.0
@@ -8,15 +8,15 @@
-
+
runtime; build; native; contentfiles; analyzers; buildtransitive
all
-
+
runtime; build; native; contentfiles; analyzers; buildtransitive
all
-
diff --git a/test/Microsoft.OpenApi.Tests/Microsoft.OpenApi.Tests.csproj b/test/Microsoft.OpenApi.Tests/Microsoft.OpenApi.Tests.csproj
index 2dcf347ba..b46619c0d 100644
--- a/test/Microsoft.OpenApi.Tests/Microsoft.OpenApi.Tests.csproj
+++ b/test/Microsoft.OpenApi.Tests/Microsoft.OpenApi.Tests.csproj
@@ -15,20 +15,20 @@
-
+
runtime; build; native; contentfiles; analyzers; buildtransitive
all
-
+
runtime; build; native; contentfiles; analyzers; buildtransitive
all
all
diff --git a/test/Microsoft.OpenApi.Tests/Models/OpenApiSchemaTests.cs b/test/Microsoft.OpenApi.Tests/Models/OpenApiSchemaTests.cs
index e4078f2f7..2a0dd0039 100644
--- a/test/Microsoft.OpenApi.Tests/Models/OpenApiSchemaTests.cs
+++ b/test/Microsoft.OpenApi.Tests/Models/OpenApiSchemaTests.cs
@@ -9,6 +9,7 @@
using FluentAssertions;
using Microsoft.OpenApi.Any;
using Microsoft.OpenApi.Extensions;
+using Microsoft.OpenApi.Interfaces;
using Microsoft.OpenApi.Models;
using Microsoft.OpenApi.Writers;
using VerifyXunit;
@@ -479,5 +480,29 @@ public void OpenApiSchemaCopyConstructorSucceeds()
Assert.Equal("date", actualSchema.Format);
Assert.True(actualSchema.Nullable);
}
+
+ [Fact]
+ public void CloningSchemaExtensionsWorks()
+ {
+ // Arrange
+ var schema = new OpenApiSchema
+ {
+ Extensions =
+ {
+ { "x-myextension", new OpenApiInteger(42) }
+ }
+ };
+
+ // Act && Assert
+ var schemaCopy = new OpenApiSchema(schema);
+ Assert.Equal(1, schemaCopy.Extensions.Count);
+
+ // Act && Assert
+ schemaCopy.Extensions = new Dictionary
+ {
+ { "x-myextension" , new OpenApiInteger(40) }
+ };
+ Assert.NotEqual(schema.Extensions, schemaCopy.Extensions);
+ }
}
}
diff --git a/test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt b/test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt
index d993a259e..96071507f 100755
--- a/test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt
+++ b/test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt
@@ -1024,6 +1024,8 @@ namespace Microsoft.OpenApi.Models
Callback = 8,
[Microsoft.OpenApi.Attributes.Display("tags")]
Tag = 9,
+ [Microsoft.OpenApi.Attributes.Display("paths")]
+ Path = 10,
}
public class RuntimeExpressionAnyWrapper : Microsoft.OpenApi.Interfaces.IOpenApiElement
{
+
+ 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**|
diff --git a/src/Microsoft.OpenApi.Hidi/Extensions/CommandExtensions.cs b/src/Microsoft.OpenApi.Hidi/Extensions/CommandExtensions.cs
new file mode 100644
index 000000000..9d5077432
--- /dev/null
+++ b/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