aspnet-api-versioning icon indicating copy to clipboard operation
aspnet-api-versioning copied to clipboard

Improve docs for HeaderApiVersionReader

Open voroninp opened this issue 1 year ago • 0 comments
trafficstars

Is there an existing issue for this?

  • [X] I have searched the existing issues

Is your feature request related to a problem? Please describe the problem.

I believe it's important to properly manage expectations. As HeaderApiVersionReader has a default constructor, one may expect there is a default header. And this is not true. It's better to be explicit about what is required for the class to perform its duties.

Describe the solution you'd like

While completely removing default constructor would be a breaking change, I believe it's worth adding xmldoc remarks, explaining that HeaderNames must be initialized.

Additional context

No response

voroninp avatar Apr 29 '24 19:04 voroninp