Skip to content

Commit cd17447

Browse files
YCcommonsensesoftware
authored andcommitted
Update documentation of ApiVersionReader in ApiVersioningOptions
The default value is a combination of QueryStringApiVersionReader and UrlSegmentApiVersionReader Resolves #1098
1 parent e3bc03a commit cd17447

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

src/Common/src/Common/ApiVersioningOptions.cs

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,16 @@ public partial class ApiVersioningOptions
5959
/// <summary>
6060
/// Gets or sets the API version reader.
6161
/// </summary>
62-
/// <value>An <see cref="IApiVersionReader">API version reader</see> object. The default value
63-
/// is an instance of the <see cref="QueryStringApiVersionReader"/>.</value>
64-
/// <remarks>The <see cref="IApiVersionReader">API version reader</see> is used to read the
65-
/// API version specified by a client. The default value is the
66-
/// <see cref="QueryStringApiVersionReader"/>, which only reads the API version from
67-
/// the "api-version" query string parameter. Replace the default value with an alternate
68-
/// implementation, such as the <see cref="HeaderApiVersionReader"/>, which
69-
/// can read the API version from additional information like HTTP headers.</remarks>
62+
/// <value>An <see cref="IApiVersionReader">API version reader</see> object. The default value is a combined reader
63+
/// with both <see cref="QueryStringApiVersionReader"/> and <see cref="UrlSegmentApiVersionReader"/>.</value>
64+
/// <remarks>
65+
/// The <see cref="IApiVersionReader">API version reader</see> is used to read the API version specified by a
66+
/// client. The default value consist of both <see cref="QueryStringApiVersionReader"/> and
67+
/// <see cref="UrlSegmentApiVersionReader"/>, which reads the API version from the "api-version" query string
68+
/// parameter and a path segment in the request URL respectively.
69+
/// Replace the default value with an alternate implementation, such as the <see cref="HeaderApiVersionReader"/>,
70+
/// which can read the API version from additional information like HTTP headers.
71+
/// </remarks>
7072
#if !NETFRAMEWORK
7173
[CLSCompliant( false )]
7274
#endif

0 commit comments

Comments
 (0)