From 6b4412a3d82d95973e218639c0eb3ad509e8a149 Mon Sep 17 00:00:00 2001 From: Steven Tang Date: Sat, 30 Aug 2025 20:14:23 +1000 Subject: [PATCH 1/2] Update documentation of ApiVersionReader in ApiVersioningOptions The default value is a combination of QueryStringApiVersionReader and UrlSegmentApiVersionReader Resolves #1098 --- src/Common/src/Common/ApiVersioningOptions.cs | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/src/Common/src/Common/ApiVersioningOptions.cs b/src/Common/src/Common/ApiVersioningOptions.cs index 82c1cfce..75f22711 100644 --- a/src/Common/src/Common/ApiVersioningOptions.cs +++ b/src/Common/src/Common/ApiVersioningOptions.cs @@ -59,14 +59,16 @@ public partial class ApiVersioningOptions /// /// Gets or sets the API version reader. /// - /// An API version reader object. The default value - /// is an instance of the . - /// The API version reader is used to read the - /// API version specified by a client. The default value is the - /// , which only reads the API version from - /// the "api-version" query string parameter. Replace the default value with an alternate - /// implementation, such as the , which - /// can read the API version from additional information like HTTP headers. + /// An API version reader object. The default value is a combined reader + /// with both and . + /// + /// The API version reader is used to read the API version specified by a + /// client. The default value consist of both and + /// , which reads the API version from the "api-version" query string + /// parameter and a path segment in the request URL respectively. + /// Replace the default value with an alternate implementation, such as the , + /// which can read the API version from additional information like HTTP headers. + /// #if !NETFRAMEWORK [CLSCompliant( false )] #endif From 9f1f13282c509648028438a4b90554f37584efcf Mon Sep 17 00:00:00 2001 From: Steven Tang Date: Sat, 30 Aug 2025 20:24:57 +1000 Subject: [PATCH 2/2] Fix Contributor Guide link in Pull Request Template --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index d3130c5b..e3c10e68 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -4,7 +4,7 @@ -- [ ] You've read the [Contributor Guide](https://github.com/dotnet/aspnet-api-versioning/blob/main/CONTRIBUTING.md) and [Code of Conduct](https://dotnetfoundation.org/code-of-conduct). +- [ ] You've read the [Contributor Guide](https://github.com/dotnet/aspnet-api-versioning/blob/main/docs/CONTRIBUTING.md) and [Code of Conduct](https://dotnetfoundation.org/code-of-conduct). - [ ] You've included unit or integration tests for your change, where applicable. - [ ] You've included inline docs for your change, where applicable. - [ ] There's an open issue for the PR that you are making. If you'd like to propose a new feature or change, please open an issue to discuss the change or find an existing issue.