Skip to content

Update documentation of ApiVersionReader in ApiVersioningOptions #1139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update documentation of ApiVersionReader in ApiVersioningOptions #1139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6b4412a
Update documentation of ApiVersionReader in ApiVersioningOptions
YC Aug 30, 2025
9f1f132
Fix Contributor Guide link in Pull Request Template
YC Aug 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<!-- If this is your first PR in the ASP.NET API Versioning repo, please run through the checklist below to ensure a smooth review and merge process for your PR. -->

- [ ] 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.
Expand Down
18 changes: 10 additions & 8 deletions src/Common/src/Common/ApiVersioningOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,14 +59,16 @@ public partial class ApiVersioningOptions
/// <summary>
/// Gets or sets the API version reader.
/// </summary>
/// <value>An <see cref="IApiVersionReader">API version reader</see> object. The default value
/// is an instance of the <see cref="QueryStringApiVersionReader"/>.</value>
/// <remarks>The <see cref="IApiVersionReader">API version reader</see> is used to read the
/// API version specified by a client. The default value is the
/// <see cref="QueryStringApiVersionReader"/>, which only reads the API version from
/// the "api-version" query string parameter. Replace the default value with an alternate
/// implementation, such as the <see cref="HeaderApiVersionReader"/>, which
/// can read the API version from additional information like HTTP headers.</remarks>
/// <value>An <see cref="IApiVersionReader">API version reader</see> object. The default value is a combined reader
/// with both <see cref="QueryStringApiVersionReader"/> and <see cref="UrlSegmentApiVersionReader"/>.</value>
/// <remarks>
/// The <see cref="IApiVersionReader">API version reader</see> is used to read the API version specified by a
/// client. The default value consist of both <see cref="QueryStringApiVersionReader"/> and
/// <see cref="UrlSegmentApiVersionReader"/>, 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 <see cref="HeaderApiVersionReader"/>,
/// which can read the API version from additional information like HTTP headers.
/// </remarks>
#if !NETFRAMEWORK
[CLSCompliant( false )]
#endif
Expand Down