You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,16 +28,17 @@ Because one major consumer of these libraries is ASP.net, the support policy of
28
28
29
29
The following table outlines the mapping between package major versions, dotnet versions, and which contributions are accepted. As a consumer, make sure the version of this library your application is using is aligned with the version of ASP.net described in the table below.
30
30
31
-
| Major version | Branch | Supported ASP.NET versions | Supported OpenAPI versions | Changes provided by Microsoft | Accepted contributions | End of support date |
| 3.X | main | not available | 2.0, 3.0, 3.1, 3.2 | security, bugfixes and feature improvements | security, bugfixes and feature improvements | TBD **|
31
+
| Major version | Branch | Supported [AspNetCore OpenAPI versions](https://www.nuget.org/packages/Microsoft.AspNetCore.OpenApi)| Supported [Swashbuckle.AspNetCore version](https://www.nuget.org/packages/Swashbuckle.AspNetCore/)| Supported OpenAPI versions | Changes provided by Microsoft | Accepted contributions | End of support date |
| 3.X ²| main | not available |not available |2.0, 3.0, 3.1, 3.2 | security, bugfixes and feature improvements | security, bugfixes and feature improvements | TBD |
36
36
37
37
> Notes:
38
38
>
39
-
> * This assumes that NET 11 and above will adopt version 3 or above of this library, otherwise, it'd expand the support date for version 2 of this library.
40
-
> ** This will be conditioned by new releases of OpenAPI, this library, asp.net and asp.net's adoptions of new versions of this library.
39
+
> 1. This assumes that AspNetCore OpenAPI version 11 and above will adopt version 3 or above of this library, otherwise, it'd expand the support date for version 2 of this library.
40
+
> 2. This will be conditioned by new releases of OpenAPI, this library, ASP.NET and AspNetCore OpenAPI's adoption of new versions of this library.
41
+
> 3. This assumes that Swashbuckle.AspNetCore version 11 and above will adopt version 3 or above of this library.
Copy file name to clipboardExpand all lines: docs/upgrade-guide-2.md
+9-1Lines changed: 9 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,15 @@ We are excited to announce the new version of the OpenAPI.NET library!
12
12
OpenAPI.NET v2 is a major update to the OpenAPI.NET library. This release includes a number of performance improvements, API enhancements, and support for OpenAPI v3.1.
13
13
14
14
> [!WARNING]
15
-
> If you are using this library with ASP.NET Core version `< 10.0` then you must remain on version `1.x` as it's not compatible.
15
+
> This is a major version update that includes breaking changes. Please review this guide carefully before upgrading.
16
+
17
+
## Integrations with ASP.NET Core
18
+
19
+
If you are using this library with [AspNetCore OpenAPI versions](https://www.nuget.org/packages/Microsoft.AspNetCore.OpenApi)`< 10.0` then you must remain on version `1.x` as it's not compatible with version 2 or above of this library.
20
+
21
+
If you are using this library with [Swashbuckle.AspNetCore version](https://www.nuget.org/packages/Swashbuckle.AspNetCore/)`< 10.0` then you must remain on version `1.x` as it's not compatible with version 2 or above of this library.
22
+
23
+
The latest support policy information for this library, and integration with ASP.NET Core can be found on [the contributing documentation](https://github.com/microsoft/OpenAPI.NET/blob/main/CONTRIBUTING.md#branches-and-support-policy).
Copy file name to clipboardExpand all lines: docs/upgrade-guide-3.md
+12Lines changed: 12 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,18 @@ We are excited to announce OpenAPI.NET v3.0! This major update introduces suppor
7
7
> [!WARNING]
8
8
> This is a major version update that includes breaking changes. Please review this guide carefully before upgrading.
9
9
10
+
## Integrations with ASP.NET Core
11
+
12
+
If you are using this library with [AspNetCore OpenAPI versions](https://www.nuget.org/packages/Microsoft.AspNetCore.OpenApi)`< 10.0` then you must remain on version `1.x` as it's not compatible with version 3 or above of this library.
13
+
14
+
If you are using this library with [AspNetCore OpenAPI versions](https://www.nuget.org/packages/Microsoft.AspNetCore.OpenApi)`= 10.0` then you must remain on version `2.x` as it's not compatible with version 3 or above of this library.
15
+
16
+
If you are using this library with [Swashbuckle.AspNetCore version](https://www.nuget.org/packages/Swashbuckle.AspNetCore/)`< 10.0` then you must remain on version `1.x` as it's not compatible with version 3 or above of this library.
17
+
18
+
If you are using this library with [Swashbuckle.AspNetCore version](https://www.nuget.org/packages/Swashbuckle.AspNetCore/)`= 10.0` then you must remain on version `2.x` as it's not compatible with version 3 or above of this library.
19
+
20
+
The latest support policy information for this library, and integration with ASP.NET Core can be found on [the contributing documentation](https://github.com/microsoft/OpenAPI.NET/blob/main/CONTRIBUTING.md#branches-and-support-policy).
21
+
10
22
## OpenAPI v3.2 Support
11
23
12
24
The primary focus of OpenAPI.NET v3.0 is adding comprehensive support for OpenAPI specification v3.2. This includes new serialization methods, enhanced model properties, and expanded functionality across the entire API surface.
0 commit comments