Skip to content

Commit fbd2b4b

Browse files
authored
Merge pull request #1575 from microsoft/vnext
Releases Hidi
2 parents 581dc63 + 72c9b7d commit fbd2b4b

File tree

8 files changed

+44
-40
lines changed

8 files changed

+44
-40
lines changed

src/Microsoft.OpenApi.Hidi/Microsoft.OpenApi.Hidi.csproj

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Project Sdk="Microsoft.NET.Sdk">
1+
<Project Sdk="Microsoft.NET.Sdk">
22

33
<PropertyGroup>
44
<OutputType>Exe</OutputType>
@@ -9,7 +9,7 @@
99
<Nullable>enable</Nullable>
1010
<ToolCommandName>hidi</ToolCommandName>
1111
<PackageOutputPath>./../../artifacts</PackageOutputPath>
12-
<Version>1.3.9</Version>
12+
<Version>1.3.10</Version>
1313
<Description>OpenAPI.NET CLI tool for slicing OpenAPI documents</Description>
1414
<SignAssembly>true</SignAssembly>
1515
<!-- https://github.com/dotnet/sourcelink/blob/main/docs/README.md#embeduntrackedsources -->
@@ -35,7 +35,7 @@
3535
<PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="8.0.0" />
3636
<PackageReference Include="System.CommandLine" Version="2.0.0-beta4.22272.1" />
3737
<PackageReference Include="Microsoft.OData.Edm" Version="7.20.0" />
38-
<PackageReference Include="Microsoft.OpenApi.OData" Version="1.6.0-preview.7" />
38+
<PackageReference Include="Microsoft.OpenApi.OData" Version="1.6.0-preview.9" />
3939
<PackageReference Include="Microsoft.OpenApi.ApiManifest" Version="0.5.0-preview" />
4040
<PackageReference Include="System.CommandLine.Hosting" Version="0.4.0-alpha.22272.1" />
4141
</ItemGroup>

src/Microsoft.OpenApi.Hidi/readme.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -68,24 +68,28 @@ Used to convert file formats from JSON to YAML and vice versa and performs slici
6868
This command accepts the following parameters:
6969

7070
• --openapi(-d) - OpenAPI description file path in the local filesystem or a valid URL hosted on a HTTPS server
71-
• --csdl(-cs) - CSDL file path in the local filesystem or a valid URL hosted on a HTTPS server
72-
• --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.
73-
• --output(-o) - Output directory path for the transformed document
74-
• --clean-ouput(-co) - an optional param that allows a user to overwrite an existing file.
75-
• --version(-v) - OpenAPI specification version
71+
• --csdl(--cs) - CSDL file path in the local filesystem or a valid URL hosted on a HTTPS server
72+
• --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.
73+
• --output(-o) - Output directory path for the transformed document.
74+
• --output-folder(--of) - The output directory path for the generated files.
75+
• --clean-ouput(--co) - an optional param that allows a user to overwrite an existing file.
76+
• --version(-v) - OpenAPI specification version.
77+
• --metadata-version(--mv) - the metadata version to use.
7678
• --format(-f) - File format
77-
• --loglevel(-ll) - The log level to use when logging messages to the main output
78-
• --inline(-i) - Inline $ref instances
79-
• --resolveExternal(-ex) - Resolve external $refs
80-
• --filterByOperationIds(-op) - Slice document based on OperationId(s) provided. Accepts a comma delimited list of operation ids.
79+
• --terse-output(--to) - Produce terse json output
80+
• --settings-path(--sp) - The configuration file with CSDL conversion settings.
81+
• --loglevel(--ll) - The log level to use when logging messages to the main output
82+
• --inline-local - Inline local $ref instances
83+
• --inline-external(--ex) - Inline external $refs
84+
• --filterByOperationIds(--op) - Slice document based on OperationId(s) provided. Accepts a comma delimited list of operation ids.
8185
• --filterByTags(-t) - Slice document based on tag(s) provided. Accepts a comma delimited list of tags.
8286
• --filterByCollection(-c) - Slices the OpenAPI document based on the Postman Collection file generated by Resource Explorer
83-
• --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
87+
• --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
8488

8589
**Examples:**
8690

8791
1. Filtering by OperationIds
88-
hidi transform -d files\People.yml -f yaml -o files\People.yml -v OpenApi3_0 -op users_UpdateInsights -co
92+
hidi transform -d files\People.yml -f yaml -o files\People.yml -v OpenApi3_0 --op users_UpdateInsights --co
8993
9094
2. Filtering by Postman collection
9195
hidi transform --openapi files\People.yml --format yaml --output files\People2.yml --version OpenApi3_0 --filterByCollection Graph-Collection-0017059134807617005.postman_collection.json
@@ -94,7 +98,7 @@ This command accepts the following parameters:
9498
hidi transform --input Files/Todo.xml --output Files/Todo-subset.yml --format yaml --version OpenApi3_0 --filterByOperationIds Todos.Todo.UpdateTodo
9599
96100
4. CSDL Filtering by EntitySets and Singletons
97-
hidi transform -cs dataverse.csdl --csdlFilter "appointments,opportunities" -o appointmentsAndOpportunities.yaml -ll trace
101+
hidi transform --cs dataverse.csdl --csdlFilter "appointments,opportunities" -o appointmentsAndOpportunities.yaml --ll trace
98102
99103
Run transform -h to see all the available usage options.
100104

src/Microsoft.OpenApi.Readers/Microsoft.OpenApi.Readers.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
</PropertyGroup>
1919

2020
<ItemGroup>
21-
<PackageReference Include="SharpYaml" Version="2.1.0" />
21+
<PackageReference Include="SharpYaml" Version="2.1.1" />
2222
</ItemGroup>
2323

2424
<ItemGroup>

src/Microsoft.OpenApi.Workbench/Microsoft.OpenApi.Workbench.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
</PropertyGroup>
1010
<ItemGroup>
1111
<PackageReference Include="Microsoft.DotNet.UpgradeAssistant.Extensions.Default.Analyzers" Version="0.4.421302" PrivateAssets="all" />
12-
<PackageReference Include="Microsoft.Windows.Compatibility" Version="8.0.1" />
12+
<PackageReference Include="Microsoft.Windows.Compatibility" Version="8.0.2" />
1313
</ItemGroup>
1414
<ItemGroup>
1515
<Resource Include="Themes\Metro\HowToApplyTheme.txt" />

test/Microsoft.OpenApi.Hidi.Tests/Microsoft.OpenApi.Hidi.Tests.csproj

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@
1111
</PropertyGroup>
1212

1313
<ItemGroup>
14-
<PackageReference Include="coverlet.msbuild" Version="6.0.0" PrivateAssets="all" />
15-
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
14+
<PackageReference Include="coverlet.msbuild" Version="6.0.1" PrivateAssets="all" />
15+
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
1616
<PackageReference Include="Moq" Version="4.20.70" />
17-
<PackageReference Include="xunit" Version="2.6.6" />
18-
<PackageReference Include="xunit.runner.visualstudio" Version="2.5.6" PrivateAssets="all" />
19-
<PackageReference Include="coverlet.collector" Version="6.0.0" PrivateAssets="all" />
17+
<PackageReference Include="xunit" Version="2.7.0" />
18+
<PackageReference Include="xunit.runner.visualstudio" Version="2.5.7" PrivateAssets="all" />
19+
<PackageReference Include="coverlet.collector" Version="6.0.1" PrivateAssets="all" />
2020
</ItemGroup>
2121

2222
<ItemGroup>

test/Microsoft.OpenApi.Readers.Tests/Microsoft.OpenApi.Readers.Tests.csproj

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@
1515
</ItemGroup>
1616

1717
<ItemGroup>
18-
<PackageReference Include="coverlet.collector" Version="6.0.0" PrivateAssets="all" />
19-
<PackageReference Include="coverlet.msbuild" Version="6.0.0" PrivateAssets="all" />
20-
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
18+
<PackageReference Include="coverlet.collector" Version="6.0.1" PrivateAssets="all" />
19+
<PackageReference Include="coverlet.msbuild" Version="6.0.1" PrivateAssets="all" />
20+
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
2121
<PackageReference Include="FluentAssertions" Version="6.12.0" />
2222
<PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
23-
<PackageReference Include="SharpYaml" Version="2.1.0" />
24-
<PackageReference Include="xunit" Version="2.6.6" />
25-
<PackageReference Include="xunit.runner.visualstudio" Version="2.5.6" PrivateAssets="all" />
23+
<PackageReference Include="SharpYaml" Version="2.1.1" />
24+
<PackageReference Include="xunit" Version="2.7.0" />
25+
<PackageReference Include="xunit.runner.visualstudio" Version="2.5.7" PrivateAssets="all" />
2626
</ItemGroup>
2727

2828
<ItemGroup>

test/Microsoft.OpenApi.SmokeTests/Microsoft.OpenApi.SmokeTests.csproj

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@
88
</PropertyGroup>
99

1010
<ItemGroup>
11-
<PackageReference Include="coverlet.collector" Version="6.0.0" PrivateAssets="all" />
12-
<PackageReference Include="coverlet.msbuild" Version="6.0.0" PrivateAssets="all" />
13-
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
11+
<PackageReference Include="coverlet.collector" Version="6.0.1" PrivateAssets="all" />
12+
<PackageReference Include="coverlet.msbuild" Version="6.0.1" PrivateAssets="all" />
13+
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
1414
<PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
15-
<PackageReference Include="xunit" Version="2.6.6" />
16-
<PackageReference Include="xunit.runner.visualstudio" Version="2.5.6" PrivateAssets="all" />
15+
<PackageReference Include="xunit" Version="2.7.0" />
16+
<PackageReference Include="xunit.runner.visualstudio" Version="2.5.7" PrivateAssets="all" />
1717
</ItemGroup>
1818

1919
<ItemGroup>

test/Microsoft.OpenApi.Tests/Microsoft.OpenApi.Tests.csproj

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@
88
</PropertyGroup>
99

1010
<ItemGroup>
11-
<PackageReference Include="coverlet.collector" Version="6.0.0" PrivateAssets="all" />
12-
<PackageReference Include="coverlet.msbuild" Version="6.0.0" PrivateAssets="all" />
11+
<PackageReference Include="coverlet.collector" Version="6.0.1" PrivateAssets="all" />
12+
<PackageReference Include="coverlet.msbuild" Version="6.0.1" PrivateAssets="all" />
1313
<PackageReference Include="FluentAssertions" Version="6.12.0" />
14-
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
14+
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
1515
<PackageReference Include="Moq" Version="4.20.70" />
1616
<PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
17-
<PackageReference Include="SharpYaml" Version="2.1.0" />
18-
<PackageReference Include="Verify.Xunit" Version="23.1.0" />
19-
<PackageReference Include="xunit" Version="2.6.6" />
20-
<PackageReference Include="xunit.runner.visualstudio" Version="2.5.6" PrivateAssets="all" />
17+
<PackageReference Include="SharpYaml" Version="2.1.1" />
18+
<PackageReference Include="Verify.Xunit" Version="23.2.2" />
19+
<PackageReference Include="xunit" Version="2.7.0" />
20+
<PackageReference Include="xunit.runner.visualstudio" Version="2.5.7" PrivateAssets="all" />
2121
<PackageReference Include="Microsoft.CSharp" Version="4.7.0" />
2222
<PackageReference Include="PublicApiGenerator" Version="11.1.0" />
2323
</ItemGroup>

0 commit comments

Comments
 (0)