Skip to content

Commit d1c6fca

Browse files
darrelmillerdarrelmiller
committed
Merge branch 'po/PowerShellSlicingExtra' into filterbymanifest
2 parents ca241c0 + dc16fed commit d1c6fca

File tree

6 files changed

+38
-15
lines changed

6 files changed

+38
-15
lines changed

‎README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
|--|--|
77
|Models and Writers|[![nuget](https://img.shields.io/nuget/v/Microsoft.OpenApi.svg)](https://www.nuget.org/packages/Microsoft.OpenApi/) |
88
|Readers | [![nuget](https://img.shields.io/nuget/v/Microsoft.OpenApi.Readers.svg)](https://www.nuget.org/packages/Microsoft.OpenApi.Readers/) |
9+
|Hidi|[![nuget](https://img.shields.io/nuget/v/Microsoft.OpenApi.Hidi.svg)](https://www.nuget.org/packages/Microsoft.OpenApi.Hidi/)
910

1011

1112
The **OpenAPI.NET** SDK contains a useful object model for OpenAPI documents in .NET along with common serializers to extract raw OpenAPI JSON and YAML documents from the model.
@@ -90,6 +91,28 @@ var outputString = openApiDocument.Serialize(OpenApiSpecVersion.OpenApi2_0, Open
9091

9192
```
9293

94+
# Validating/Testing OpenAPI descriptions
95+
In order to test the validity of an OpenApi document, we avail the following tools:
96+
- [Microsoft.OpenApi.Hidi](https://www.nuget.org/packages/Microsoft.OpenApi.Hidi)
97+
98+
A commandline tool for validating and transforming OpenAPI descriptions. [Installation guidelines and documentation](https://github.com/microsoft/OpenAPI.NET/blob/vnext/src/Microsoft.OpenApi.Hidi/readme.md)
99+
100+
- Microsoft.OpenApi.Workbench
101+
102+
A workbench tool consisting of a GUI where you can test and convert OpenAPI descriptions in both JSON and YAML from v2-->v3 and vice versa.
103+
104+
#### Installation guidelines:
105+
1. Clone the repo locally by running this command:
106+
`git clone https://github.com/microsoft/OpenAPI.NET.git`
107+
2. Open the solution file `(.sln)` in the root of the project with Visual Studio
108+
3. Navigate to the `src/Microsoft.OpenApi.Workbench` directory and set it as the startup project
109+
4. Run the project and you'll see a GUI pop up resembling the one below:
110+
111+
112+
<img src="https://user-images.githubusercontent.com/36787645/235884441-f45d2ef7-c27b-4e1a-a890-d6f7fbef87c3.png" width="700" height="500">
113+
114+
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.
115+
93116
# Build Status
94117

95118
|**master**|

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
<PackageReference Include="Microsoft.Extensions.Logging.Console" Version="7.0.0" />
4444
<PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="7.0.0" />
4545
<PackageReference Include="System.CommandLine" Version="2.0.0-beta4.22272.1" />
46-
<PackageReference Include="Microsoft.OData.Edm" Version="7.15.0" />
46+
<PackageReference Include="Microsoft.OData.Edm" Version="7.16.0" />
4747
<PackageReference Include="Microsoft.OpenApi.OData" Version="1.4.0" />
4848
<PackageReference Include="System.CommandLine.Hosting" Version="0.4.0-alpha.22272.1" />
4949
</ItemGroup>

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,18 @@
99
</PropertyGroup>
1010

1111
<ItemGroup>
12-
<PackageReference Include="coverlet.msbuild" Version="3.2.0">
12+
<PackageReference Include="coverlet.msbuild" Version="6.0.0">
1313
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
1414
<PrivateAssets>all</PrivateAssets>
1515
</PackageReference>
16-
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.5.0" />
16+
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.0" />
1717
<PackageReference Include="Moq" Version="4.18.4" />
1818
<PackageReference Include="xunit" Version="2.4.2" />
1919
<PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
2020
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
2121
<PrivateAssets>all</PrivateAssets>
2222
</PackageReference>
23-
<PackageReference Include="coverlet.collector" Version="3.2.0">
23+
<PackageReference Include="coverlet.collector" Version="6.0.0">
2424
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
2525
<PrivateAssets>all</PrivateAssets>
2626
</PackageReference>

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -256,15 +256,15 @@
256256
</ItemGroup>
257257

258258
<ItemGroup>
259-
<PackageReference Include="coverlet.collector" Version="3.2.0">
259+
<PackageReference Include="coverlet.collector" Version="6.0.0">
260260
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
261261
<PrivateAssets>all</PrivateAssets>
262262
</PackageReference>
263-
<PackageReference Include="coverlet.msbuild" Version="3.2.0">
263+
<PackageReference Include="coverlet.msbuild" Version="6.0.0">
264264
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
265265
<PrivateAssets>all</PrivateAssets>
266266
</PackageReference>
267-
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.5.0" />
267+
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.0" />
268268
<PackageReference Include="FluentAssertions" Version="6.11.0">
269269
</PackageReference>
270270
<PackageReference Include="Newtonsoft.Json" Version="13.0.3">

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

Lines changed: 4 additions & 4 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
<TargetFrameworks>net7.0</TargetFrameworks>
@@ -8,15 +8,15 @@
88
</PropertyGroup>
99

1010
<ItemGroup>
11-
<PackageReference Include="coverlet.collector" Version="3.2.0">
11+
<PackageReference Include="coverlet.collector" Version="6.0.0">
1212
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
1313
<PrivateAssets>all</PrivateAssets>
1414
</PackageReference>
15-
<PackageReference Include="coverlet.msbuild" Version="3.2.0">
15+
<PackageReference Include="coverlet.msbuild" Version="6.0.0">
1616
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
1717
<PrivateAssets>all</PrivateAssets>
1818
</PackageReference>
19-
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.5.0" />
19+
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.0" />
2020
<PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
2121
<PackageReference Include="xunit" Version="2.4.2" />
2222
<PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,20 @@
1515
</PropertyGroup>
1616

1717
<ItemGroup>
18-
<PackageReference Include="coverlet.collector" Version="3.2.0">
18+
<PackageReference Include="coverlet.collector" Version="6.0.0">
1919
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
2020
<PrivateAssets>all</PrivateAssets>
2121
</PackageReference>
22-
<PackageReference Include="coverlet.msbuild" Version="3.2.0">
22+
<PackageReference Include="coverlet.msbuild" Version="6.0.0">
2323
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
2424
<PrivateAssets>all</PrivateAssets>
2525
</PackageReference>
2626
<PackageReference Include="FluentAssertions" Version="6.11.0" />
27-
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.5.0" />
27+
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.0" />
2828
<PackageReference Include="Moq" Version="4.18.4" />
2929
<PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
3030
<PackageReference Include="SharpYaml" Version="2.1.0" />
31-
<PackageReference Include="Verify.Xunit" Version="19.13.1" />
31+
<PackageReference Include="Verify.Xunit" Version="19.14.1" />
3232
<PackageReference Include="xunit" Version="2.4.2" />
3333
<PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
3434
<PrivateAssets>all</PrivateAssets>

0 commit comments

Comments
 (0)