falconry / falcon

The no-magic web data plane API and microservices framework for Python developers, with a focus on reliability, correctness, and performance at scale.
https://falcon.readthedocs.io/en/stable/
Apache License 2.0
9.51k stars 937 forks source link

FAQ item on RequestOptions.keep_blank_qs_values is outdated/incorrect #1964

Closed vytas7 closed 2 years ago

vytas7 commented 2 years ago

At the time of writing, the FAQ item "Why is my query parameter missing from the req object?" states that

If a query param does not have a value, Falcon will by default ignore that parameter. For example, passing 'foo' or 'foo=' will result in the parameter being ignored.

As of Falcon 2.0+, this is incorrect, and the default value for RequestOptions.keep_blank_qs_values is True.

However, I believe we should still keep the FAQ item in the case one has set the option to False for any reason (or maybe someone else working on the same code base has done that), and is wondering what's going on.