Skip to content

Clarify OpenAPI 3 coerce_form_params behavior#471

Merged
geemus merged 1 commit intomasterfrom
fix/issue-429-coerce-form-params-docs
Mar 28, 2026
Merged

Clarify OpenAPI 3 coerce_form_params behavior#471
geemus merged 1 commit intomasterfrom
fix/issue-429-coerce-form-params-docs

Conversation

@ydah
Copy link
Copy Markdown
Member

@ydah ydah commented Mar 25, 2026

Fixes #429

  • clarify README wording for OpenAPI 3 coerce_form_params behavior
  • add a regression test showing that the option coerces JSON request bodies
  • update the OpenAPI 3 driver comment to match the implementation

@geemus
Copy link
Copy Markdown
Member

geemus commented Mar 28, 2026

LGTM, definitely appreciate the docs being accurate.

In the future we might consider adding a new flag with a clearer/more obvious name that reflects the new usage/expectations and just keeping this flag for backwards compatibility. That being said, that might also be confusing as it wouldn't really reflect pre openapi 3 behavior. Maybe it should be two flags? I don't know, this seems like the right thing to do for now, but maybe we can revisit at some point.

@geemus geemus merged commit af0b159 into master Mar 28, 2026
9 checks passed
@geemus geemus deleted the fix/issue-429-coerce-form-params-docs branch March 28, 2026 13:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation misleading about coerce_form_params option

2 participants