Skip to content
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.

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

Documentation: Default value for ApiVersionReader is misleading #1098

Open
1 task done
YC opened this issue Jun 24, 2024 · 0 comments
Open
1 task done

Documentation: Default value for ApiVersionReader is misleading #1098

YC opened this issue Jun 24, 2024 · 0 comments
Assignees

Comments

@YC
Copy link

YC commented Jun 24, 2024

Is there an existing issue for this?

  • I have searched the existing issues

Describe the bug

According to the documentation comment:

The default value is the QueryStringApiVersionReader, which only reads the API version from the "api-version" query string parameter.

Instead, the default is Combine( new QueryStringApiVersionReader(), new UrlSegmentApiVersionReader() ).

https://github.com/dotnet/aspnet-api-versioning/blob/v8.1.0/src/Common/src/Common/ApiVersioningOptions.cs#L65-L69
https://github.com/dotnet/aspnet-api-versioning/blob/v8.1.0/src/Common/src/Common/ApiVersionReader.cs#L25

Expected Behavior

The documentation should be updated to reflect that the default is a combination of both.

Steps To Reproduce

No response

Exceptions (if any)

No response

.NET Version

No response

Anything else?

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants