Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions src/Microsoft.OpenApi.Hidi/CsdlFilter.xslt
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<?xml version="1.0" encoding="utf-8"?>
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:edm="http://docs.oasis-open.org/odata/ns/edm"
xmlns:msxsl="urn:schemas-microsoft-com:xslt" exclude-result-prefixes="msxsl"
>
<xsl:output method="xml" indent="yes"/>

<xsl:param name="entitySetOrSingleton" select="'serviceappointments'"></xsl:param>

<xsl:template match="edm:EntityContainer">
<xsl:copy>
<xsl:apply-templates select="@* | edm:EntitySet[contains($entitySetOrSingleton,@Name)] | edm:Singleton[contains($entitySetOrSingleton,@Name)]"/>
</xsl:copy>
</xsl:template>

<xsl:template match="@* | node()">
<xsl:copy>
<xsl:apply-templates select="@* | node()"/>
</xsl:copy>
</xsl:template>

</xsl:stylesheet>
8 changes: 8 additions & 0 deletions src/Microsoft.OpenApi.Hidi/Microsoft.OpenApi.Hidi.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,14 @@
<EmbedUntrackedSources>true</EmbedUntrackedSources>
</PropertyGroup>

<ItemGroup>
<None Remove="CsdlFilter.xslt" />
</ItemGroup>

<ItemGroup>
<EmbeddedResource Include="CsdlFilter.xslt" />
</ItemGroup>

<ItemGroup>
<PackageReference Include="Microsoft.Extensions.Logging" Version="6.0.0" />
<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="6.0.1" />
Expand Down
41 changes: 39 additions & 2 deletions src/Microsoft.OpenApi.Hidi/OpenApiService.cs
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@
using Microsoft.OpenApi.Writers;
using static Microsoft.OpenApi.Hidi.OpenApiSpecVersionHelper;
using System.Threading;
using System.Xml.Xsl;
using System.Xml;
using System.Runtime.CompilerServices;
using System.Reflection;

namespace Microsoft.OpenApi.Hidi
{
Expand All @@ -35,6 +39,7 @@ public class OpenApiService
public static async Task<int> TransformOpenApiDocument(
string openapi,
string csdl,
string csdlFilter,
FileInfo output,
bool cleanoutput,
string? version,
Expand Down Expand Up @@ -85,6 +90,13 @@ CancellationToken cancellationToken
openApiVersion = version != null ? TryParseOpenApiSpecVersion(version) : OpenApiSpecVersion.OpenApi3_0;

stream = await GetStream(csdl, logger, cancellationToken);

if (!string.IsNullOrEmpty(csdlFilter))
{
XslCompiledTransform transform = GetFilterTransform();
stream = ApplyFilter(csdl, csdlFilter, transform);
stream.Position = 0;
}
document = await ConvertCsdlToOpenApi(stream);
stopwatch.Stop();
logger.LogTrace("{timestamp}ms: Generated OpenAPI with {paths} paths.", stopwatch.ElapsedMilliseconds, document.Paths.Count);
Expand Down Expand Up @@ -212,6 +224,31 @@ CancellationToken cancellationToken
}
}

private static XslCompiledTransform GetFilterTransform()
{
XslCompiledTransform transform = new();
Assembly assembly = typeof(OpenApiService).GetTypeInfo().Assembly;
Stream xslt = assembly.GetManifestResourceStream("Microsoft.OpenApi.Hidi.CsdlFilter.xslt");
transform.Load(new XmlTextReader(new StreamReader(xslt)));
return transform;
}

private static Stream ApplyFilter(string csdl, string entitySetOrSingleton, XslCompiledTransform transform)
{
Stream stream;
StreamReader inputReader = new(csdl);
XmlReader inputXmlReader = XmlReader.Create(inputReader);
MemoryStream filteredStream = new();
StreamWriter writer = new(filteredStream);
XsltArgumentList args = new();
args.AddParam("entitySetOrSingleton", "", entitySetOrSingleton);
transform.Transform(inputXmlReader, args, writer);
stream = filteredStream;
return stream;
}



/// <summary>
/// Implementation of the validate command
/// </summary>
Expand Down Expand Up @@ -308,8 +345,8 @@ public static async Task<OpenApiDocument> ConvertCsdlToOpenApi(Stream csdl)
EnableDiscriminatorValue = false,
EnableDerivedTypesReferencesForRequestBody = false,
EnableDerivedTypesReferencesForResponses = false,
ShowRootPath = true,
ShowLinks = true
ShowRootPath = false,
ShowLinks = false
};
OpenApiDocument document = edmModel.ConvertToOpenApi(settings);

Expand Down
14 changes: 9 additions & 5 deletions src/Microsoft.OpenApi.Hidi/Program.cs
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ static async Task Main(string[] args)
var csdlOption = new Option<string>("--csdl", "Input CSDL file path or URL");
csdlOption.AddAlias("-cs");

var csdlFilterOption = new Option<string>("--csdl-filter", "Comma delimited list of EntitySets or Singletons to filter CSDL on. e.g. tasks,accounts");
csdlFilterOption.AddAlias("-csf");

var outputOption = new Option<FileInfo>("--output", () => new FileInfo("./output"), "The output directory path for the generated file.") { Arity = ArgumentArity.ZeroOrOne };
outputOption.AddAlias("-o");

Expand All @@ -39,13 +42,13 @@ static async Task Main(string[] args)
var logLevelOption = new Option<LogLevel>("--loglevel", () => LogLevel.Information, "The log level to use when logging messages to the main output.");
logLevelOption.AddAlias("-ll");

var filterByOperationIdsOption = new Option<string>("--filter-by-operationids", "Filters OpenApiDocument by OperationId(s) provided");
var filterByOperationIdsOption = new Option<string>("--filter-by-operationids", "Filters OpenApiDocument by comma delimited list of OperationId(s) provided");
filterByOperationIdsOption.AddAlias("-op");

var filterByTagsOption = new Option<string>("--filter-by-tags", "Filters OpenApiDocument by Tag(s) provided");
var filterByTagsOption = new Option<string>("--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<string>("--filter-by-collection", "Filters OpenApiDocument by Postman collection provided");
var filterByCollectionOption = new Option<string>("--filter-by-collection", "Filters OpenApiDocument by Postman collection provided. Provide path to collection file.");
filterByCollectionOption.AddAlias("-c");

var inlineLocalOption = new Option<bool>("--inlineLocal", "Inline local $ref instances");
Expand All @@ -66,6 +69,7 @@ static async Task Main(string[] args)
{
descriptionOption,
csdlOption,
csdlFilterOption,
outputOption,
cleanOutputOption,
versionOption,
Expand All @@ -78,8 +82,8 @@ static async Task Main(string[] args)
inlineExternalOption
};

transformCommand.SetHandler<string, string, FileInfo, bool, string?, OpenApiFormat?, LogLevel, bool, bool, string, string, string, CancellationToken> (
OpenApiService.TransformOpenApiDocument, descriptionOption, csdlOption, outputOption, cleanOutputOption, versionOption, formatOption, logLevelOption, inlineLocalOption, inlineExternalOption, filterByOperationIdsOption, filterByTagsOption, filterByCollectionOption);
transformCommand.SetHandler<string, string, string, FileInfo, bool, string?, OpenApiFormat?, LogLevel, bool, bool, string, string, string, CancellationToken> (
OpenApiService.TransformOpenApiDocument, descriptionOption, csdlOption, csdlFilterOption, outputOption, cleanOutputOption, versionOption, formatOption, logLevelOption, inlineLocalOption, inlineExternalOption, filterByOperationIdsOption, filterByTagsOption, filterByCollectionOption);

rootCommand.Add(transformCommand);
rootCommand.Add(validateCommand);
Expand Down
4 changes: 2 additions & 2 deletions test/Microsoft.OpenApi.Tests/Microsoft.OpenApi.Tests.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
<PackageReference Include="Moq" Version="4.17.2" />
<PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
<PackageReference Include="SharpYaml" Version="1.9.0" />
<PackageReference Include="Verify" Version="16.4.3" />
<PackageReference Include="Verify.Xunit" Version="16.4.3" />
<PackageReference Include="Verify" Version="16.4.4" />
<PackageReference Include="Verify.Xunit" Version="16.4.4" />
<PackageReference Include="xunit" Version="2.4.1" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
<PrivateAssets>all</PrivateAssets>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public async Task ReturnConvertedCSDLFile()

// Act
var openApiDoc = await OpenApiService.ConvertCsdlToOpenApi(csdlStream);
var expectedPathCount = 6;
var expectedPathCount = 5;

// Assert
Assert.NotNull(openApiDoc);
Expand Down