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

[Rust-Axum] Allow use of array query params #20861

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

tanadeau
Copy link
Contributor

This PR updates the rust-axum templates to do the following to support array query parameters:

  1. Uses the Query extractor from axum_extra instead of axum as that supports extracting array query parameters
  2. Use serde_html_form instead of serde_urlencoded for the same reason. Also the latter crate appears to be unmaintained. See https://docs.rs/serde_html_form/latest/serde_html_form/.
  3. Updates the *QueryParams models based on guidance from above docs.

FYI: @frol @farcaller @richardwhiuk @paladinzh @jacob-pro

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@wing328
Copy link
Member

wing328 commented Mar 13, 2025

thanks for the PR

cc @linxGnu

@wing328
Copy link
Member

wing328 commented Mar 20, 2025

what about adding a config similar to those in https://github.com/OpenAPITools/openapi-generator/tree/master/bin/configs/manual to test array of query params (and commit the new samples)?

@@ -207,7 +207,6 @@ use crate::{models, types::*};
#[cfg_attr(feature = "conversion", derive(frunk::LabelledGeneric))]
pub struct {{{operationIdCamelCase}}}QueryParams {
{{#queryParams}}
{{#vendorExtensions}}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tanadeau could you please explain why we need to remove vendorExtensions?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This created the wrong context, and within it, the template couldn't get the correct values for isArray, etc. It's now also consistent with the other blocks for header params, path params, etc. They would have had the same issue.

serde_json = { version = "1", features = ["raw_value"] }
serde_urlencoded = "0.7"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could you please also explain why we need to replace serde_urlencoded with serde_html_form?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

serde_urlencoded explicitly doesn't support array query params and will never do so. See nox/serde_urlencoded#52 for example. serde_html_form is a fork with that in mind. See item 2 in the PR description.

@tanadeau
Copy link
Contributor Author

what about adding a config similar to those in https://github.com/OpenAPITools/openapi-generator/tree/master/bin/configs/manual to test array of query params (and commit the new samples)?

I'll do that.

@tanadeau tanadeau requested a review from linxGnu March 25, 2025 21:15
@tanadeau
Copy link
Contributor Author

I believe I've addressed all comments.

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

Successfully merging this pull request may close these issues.

3 participants