Skip to content

Commit 3274dec

Browse files
Apply suggestions from code review
Co-authored-by: Martin Costello <[email protected]>
1 parent 945f37b commit 3274dec

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,15 @@ The following table outlines the mapping between package major versions, dotnet
3030

3131
| 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 |
3232
| ------------- | ---------- | -------------------------- | ---------- | -------------------------- | ------------------------------------------- | ------------------------------------------- | --------------- |
33-
| 1.X | support/v1 | < 10 | < 10 | 2.0, 3.0 | security fixes | security and bugfixes | net 9 (Nov 2026) |
34-
| 2.X | support/v2 | = 10 ¹ | = 10 ³ | 2.0, 3.0, 3.1 | security and bugfixes | security and bugfixes | net 10 (Nov 2028) ¹ |
33+
| 1.X | support/v1 | < 10 | < 10 | 2.0, 3.0 | security fixes | security and bugfixes | .NET 9 (Nov 2026) |
34+
| 2.X | support/v2 | = 10 ¹ | = 10 ³ | 2.0, 3.0, 3.1 | security and bugfixes | security and bugfixes | .NET 10 (Nov 2028) ¹ |
3535
| 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 |
3636

3737
> Notes:
3838
>
3939
> 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 version 11 and above will adopt version 3 or above 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.
4242
4343
### Multi-versions requirement for contributions
4444

docs/upgrade-guide-2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ If you are using this library with [AspNetCore OpenAPI versions](https://www.nug
2020

2121
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.
2222

23-
The latest support policy information for this library, and integration with ASP.NET can be found on [the contributing documentation](https://github.com/microsoft/OpenAPI.NET/blob/main/CONTRIBUTING.md#branches-and-support-policy).
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).
2424

2525
## The biggest update ever
2626

docs/upgrade-guide-3.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,17 @@ We are excited to announce OpenAPI.NET v3.0! This major update introduces suppor
77
> [!WARNING]
88
> This is a major version update that includes breaking changes. Please review this guide carefully before upgrading.
99
10-
## Integrations with ASP.NET
10+
## Integrations with ASP.NET Core
1111

1212
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.
1313

1414
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.
1515

1616
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.
1717

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.
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.
1919

20-
The latest support policy information for this library, and integration with ASP.NET can be found on [the contributing documentation](https://github.com/microsoft/OpenAPI.NET/blob/main/CONTRIBUTING.md#branches-and-support-policy).
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).
2121

2222
## OpenAPI v3.2 Support
2323

0 commit comments

Comments
 (0)