Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Releases Hidi #1575

Merged
merged 30 commits into from
Mar 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
ca77751
Update readme.md
MaggieKimani1 Feb 5, 2024
ebfc2ba
Bump Microsoft.NET.Test.Sdk from 17.8.0 to 17.9.0
dependabot[bot] Feb 6, 2024
9d15ca3
Merge pull request #1552 from microsoft/dependabot/nuget/Microsoft.NE…
baywet Feb 6, 2024
3c987ad
Update command option description
MaggieKimani1 Feb 7, 2024
d812ec5
Merge pull request #1547 from microsoft/mk/update-hidi-cmd-options
MaggieKimani1 Feb 7, 2024
58cfb22
Bump SharpYaml from 2.1.0 to 2.1.1
dependabot[bot] Feb 13, 2024
e3c387c
Bump Microsoft.Windows.Compatibility from 8.0.1 to 8.0.2
dependabot[bot] Feb 13, 2024
cf2f60e
Merge pull request #1557 from microsoft/dependabot/nuget/Microsoft.Wi…
baywet Feb 13, 2024
a3c2d1e
Merge pull request #1556 from microsoft/dependabot/nuget/SharpYaml-2.1.1
baywet Feb 13, 2024
c66ea77
Bump Verify.Xunit from 23.1.0 to 23.2.0
dependabot[bot] Feb 15, 2024
3ff45fa
Merge pull request #1559 from microsoft/dependabot/nuget/Verify.Xunit…
baywet Feb 15, 2024
cac6220
Bump xunit.runner.visualstudio from 2.5.6 to 2.5.7
dependabot[bot] Feb 16, 2024
a4d2e8a
Merge pull request #1560 from microsoft/dependabot/nuget/xunit.runner…
baywet Feb 17, 2024
11608ef
Bump xunit from 2.6.6 to 2.7.0
dependabot[bot] Feb 17, 2024
9ebc02e
Merge pull request #1561 from microsoft/dependabot/nuget/xunit-2.7.0
baywet Feb 17, 2024
b1d24f0
Bump coverlet.collector from 6.0.0 to 6.0.1
dependabot[bot] Feb 21, 2024
be59a4f
Bump Verify.Xunit from 23.2.0 to 23.2.1
dependabot[bot] Feb 21, 2024
aa1fa5a
Merge pull request #1566 from microsoft/dependabot/nuget/Verify.Xunit…
baywet Feb 21, 2024
8b4ce57
Merge pull request #1564 from microsoft/dependabot/nuget/coverlet.col…
baywet Feb 21, 2024
783c122
Bump coverlet.msbuild from 6.0.0 to 6.0.1
dependabot[bot] Feb 21, 2024
e0e5ca3
Merge pull request #1565 from microsoft/dependabot/nuget/coverlet.msb…
andrueastman Feb 22, 2024
11b71b4
Bump SharpYaml from 2.1.0 to 2.1.1
dependabot[bot] Feb 23, 2024
942b6ca
Bump Microsoft.OpenApi.OData from 1.6.0-preview.7 to 1.6.0-preview.8
dependabot[bot] Feb 23, 2024
1bf8e53
Merge pull request #1568 from microsoft/dependabot/nuget/Microsoft.Op…
baywet Feb 23, 2024
c7aa71a
Merge pull request #1567 from microsoft/dependabot/nuget/SharpYaml-2.1.1
baywet Feb 24, 2024
4f36bc2
Bump Verify.Xunit from 23.2.1 to 23.2.2
dependabot[bot] Feb 27, 2024
826922a
Merge pull request #1570 from microsoft/dependabot/nuget/Verify.Xunit…
baywet Feb 27, 2024
7709058
Bump Microsoft.OpenApi.OData from 1.6.0-preview.8 to 1.6.0-preview.9
dependabot[bot] Mar 1, 2024
61f467d
Merge pull request #1573 from microsoft/dependabot/nuget/Microsoft.Op…
baywet Mar 1, 2024
72c9b7d
Bump Hidi (#1574)
irvinesunday Mar 4, 2024
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
6 changes: 3 additions & 3 deletions src/Microsoft.OpenApi.Hidi/Microsoft.OpenApi.Hidi.csproj
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<OutputType>Exe</OutputType>
Expand All @@ -9,7 +9,7 @@
<Nullable>enable</Nullable>
<ToolCommandName>hidi</ToolCommandName>
<PackageOutputPath>./../../artifacts</PackageOutputPath>
<Version>1.3.9</Version>
<Version>1.3.10</Version>
<Description>OpenAPI.NET CLI tool for slicing OpenAPI documents</Description>
<SignAssembly>true</SignAssembly>
<!-- https://github.com/dotnet/sourcelink/blob/main/docs/README.md#embeduntrackedsources -->
Expand All @@ -35,7 +35,7 @@
<PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="8.0.0" />
<PackageReference Include="System.CommandLine" Version="2.0.0-beta4.22272.1" />
<PackageReference Include="Microsoft.OData.Edm" Version="7.20.0" />
<PackageReference Include="Microsoft.OpenApi.OData" Version="1.6.0-preview.7" />
<PackageReference Include="Microsoft.OpenApi.OData" Version="1.6.0-preview.9" />
<PackageReference Include="Microsoft.OpenApi.ApiManifest" Version="0.5.0-preview" />
<PackageReference Include="System.CommandLine.Hosting" Version="0.4.0-alpha.22272.1" />
</ItemGroup>
Expand Down
28 changes: 16 additions & 12 deletions src/Microsoft.OpenApi.Hidi/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,24 +68,28 @@ Used to convert file formats from JSON to YAML and vice versa and performs slici
This command accepts the following parameters:

• --openapi(-d) - OpenAPI description file path in the local filesystem or a valid URL hosted on a HTTPS server
• --csdl(-cs) - CSDL file path in the local filesystem or a valid URL hosted on a HTTPS server
• --csdlfilter(-csf) - a filter parameter that a user can use to select a subset of a large CSDL file. They do so by providing a comma delimited list of EntitySet and Singleton names that appear in the EntityContainer.
• --output(-o) - Output directory path for the transformed document
• --clean-ouput(-co) - an optional param that allows a user to overwrite an existing file.
• --version(-v) - OpenAPI specification version
• --csdl(--cs) - CSDL file path in the local filesystem or a valid URL hosted on a HTTPS server
• --csdlfilter(--csf) - a filter parameter that a user can use to select a subset of a large CSDL file. They do so by providing a comma delimited list of EntitySet and Singleton names that appear in the EntityContainer.
• --output(-o) - Output directory path for the transformed document.
• --output-folder(--of) - The output directory path for the generated files.
• --clean-ouput(--co) - an optional param that allows a user to overwrite an existing file.
• --version(-v) - OpenAPI specification version.
• --metadata-version(--mv) - the metadata version to use.
• --format(-f) - File format
• --loglevel(-ll) - The log level to use when logging messages to the main output
• --inline(-i) - Inline $ref instances
• --resolveExternal(-ex) - Resolve external $refs
• --filterByOperationIds(-op) - Slice document based on OperationId(s) provided. Accepts a comma delimited list of operation ids.
• --terse-output(--to) - Produce terse json output
• --settings-path(--sp) - The configuration file with CSDL conversion settings.
• --loglevel(--ll) - The log level to use when logging messages to the main output
• --inline-local - Inline local $ref instances
• --inline-external(--ex) - Inline external $refs
• --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
• --manifest (-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:**

1. Filtering by OperationIds
hidi transform -d files\People.yml -f yaml -o files\People.yml -v OpenApi3_0 -op users_UpdateInsights -co
hidi transform -d files\People.yml -f yaml -o files\People.yml -v OpenApi3_0 --op users_UpdateInsights --co

2. Filtering by Postman collection
hidi transform --openapi files\People.yml --format yaml --output files\People2.yml --version OpenApi3_0 --filterByCollection Graph-Collection-0017059134807617005.postman_collection.json
Expand All @@ -94,7 +98,7 @@ This command accepts the following parameters:
hidi transform --input Files/Todo.xml --output Files/Todo-subset.yml --format yaml --version OpenApi3_0 --filterByOperationIds Todos.Todo.UpdateTodo

4. CSDL Filtering by EntitySets and Singletons
hidi transform -cs dataverse.csdl --csdlFilter "appointments,opportunities" -o appointmentsAndOpportunities.yaml -ll trace
hidi transform --cs dataverse.csdl --csdlFilter "appointments,opportunities" -o appointmentsAndOpportunities.yaml --ll trace

Run transform -h to see all the available usage options.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
</PropertyGroup>

<ItemGroup>
<PackageReference Include="SharpYaml" Version="2.1.0" />
<PackageReference Include="SharpYaml" Version="2.1.1" />
</ItemGroup>

<ItemGroup>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Microsoft.DotNet.UpgradeAssistant.Extensions.Default.Analyzers" Version="0.4.421302" PrivateAssets="all" />
<PackageReference Include="Microsoft.Windows.Compatibility" Version="8.0.1" />
<PackageReference Include="Microsoft.Windows.Compatibility" Version="8.0.2" />
</ItemGroup>
<ItemGroup>
<Resource Include="Themes\Metro\HowToApplyTheme.txt" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@
</PropertyGroup>

<ItemGroup>
<PackageReference Include="coverlet.msbuild" Version="6.0.0" PrivateAssets="all" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
<PackageReference Include="coverlet.msbuild" Version="6.0.1" PrivateAssets="all" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
<PackageReference Include="Moq" Version="4.20.70" />
<PackageReference Include="xunit" Version="2.6.6" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.5.6" PrivateAssets="all" />
<PackageReference Include="coverlet.collector" Version="6.0.0" PrivateAssets="all" />
<PackageReference Include="xunit" Version="2.7.0" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.5.7" PrivateAssets="all" />
<PackageReference Include="coverlet.collector" Version="6.0.1" PrivateAssets="all" />
</ItemGroup>

<ItemGroup>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@
</ItemGroup>

<ItemGroup>
<PackageReference Include="coverlet.collector" Version="6.0.0" PrivateAssets="all" />
<PackageReference Include="coverlet.msbuild" Version="6.0.0" PrivateAssets="all" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
<PackageReference Include="coverlet.collector" Version="6.0.1" PrivateAssets="all" />
<PackageReference Include="coverlet.msbuild" Version="6.0.1" PrivateAssets="all" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
<PackageReference Include="FluentAssertions" Version="6.12.0" />
<PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
<PackageReference Include="SharpYaml" Version="2.1.0" />
<PackageReference Include="xunit" Version="2.6.6" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.5.6" PrivateAssets="all" />
<PackageReference Include="SharpYaml" Version="2.1.1" />
<PackageReference Include="xunit" Version="2.7.0" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.5.7" PrivateAssets="all" />
</ItemGroup>

<ItemGroup>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@
</PropertyGroup>

<ItemGroup>
<PackageReference Include="coverlet.collector" Version="6.0.0" PrivateAssets="all" />
<PackageReference Include="coverlet.msbuild" Version="6.0.0" PrivateAssets="all" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
<PackageReference Include="coverlet.collector" Version="6.0.1" PrivateAssets="all" />
<PackageReference Include="coverlet.msbuild" Version="6.0.1" PrivateAssets="all" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
<PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
<PackageReference Include="xunit" Version="2.6.6" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.5.6" PrivateAssets="all" />
<PackageReference Include="xunit" Version="2.7.0" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.5.7" PrivateAssets="all" />
</ItemGroup>

<ItemGroup>
Expand Down
14 changes: 7 additions & 7 deletions test/Microsoft.OpenApi.Tests/Microsoft.OpenApi.Tests.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@
</PropertyGroup>

<ItemGroup>
<PackageReference Include="coverlet.collector" Version="6.0.0" PrivateAssets="all" />
<PackageReference Include="coverlet.msbuild" Version="6.0.0" PrivateAssets="all" />
<PackageReference Include="coverlet.collector" Version="6.0.1" PrivateAssets="all" />
<PackageReference Include="coverlet.msbuild" Version="6.0.1" PrivateAssets="all" />
<PackageReference Include="FluentAssertions" Version="6.12.0" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
<PackageReference Include="Moq" Version="4.20.70" />
<PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
<PackageReference Include="SharpYaml" Version="2.1.0" />
<PackageReference Include="Verify.Xunit" Version="23.1.0" />
<PackageReference Include="xunit" Version="2.6.6" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.5.6" PrivateAssets="all" />
<PackageReference Include="SharpYaml" Version="2.1.1" />
<PackageReference Include="Verify.Xunit" Version="23.2.2" />
<PackageReference Include="xunit" Version="2.7.0" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.5.7" PrivateAssets="all" />
<PackageReference Include="Microsoft.CSharp" Version="4.7.0" />
<PackageReference Include="PublicApiGenerator" Version="11.1.0" />
</ItemGroup>
Expand Down
Loading