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-reqwest]: allow rust configuration struct to be deserialized #18688

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

Conversation

maxnachlinger
Copy link
Contributor

Allow rust configuration struct to be deserialized, so it may be easily constructed from a file or other source.
Fixes: #18687

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 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (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.1.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.

…e easily constructed from a file or other source
@maxnachlinger maxnachlinger marked this pull request as ready for review May 16, 2024 14:43
@maxnachlinger maxnachlinger marked this pull request as draft May 16, 2024 15:03
…e easily constructed from a file or other source
Comment on lines +11 to +20
#[derive(Debug, Clone, Deserialize)]
pub struct DeserializedConfiguration {
pub base_path: String,
pub user_agent: Option<String>,
pub basic_auth: Option<BasicAuth>,
pub oauth_access_token: Option<String>,
pub bearer_access_token: Option<String>,
pub api_key: Option<ApiKey>,
// TODO: take an oauth2 token source, similar to the go one
}
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 allows users to read configuration from a file, which I imagine is a common use case.

Some of the structs used in config don't implement Deserialize - thinking of Secret for example. Also some of the properties of the Configuration struct cannot be decorated with #[serde(skip)] either as they don't implement Default.

So I guess this struct is the best we can do with those constraints.

@@ -89,3 +101,18 @@ impl Default for Configuration {
}
}
}

impl From<DeserializedConfiguration> for Configuration {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Make a Configuration from a DeserializedConfiguration

@maxnachlinger maxnachlinger marked this pull request as ready for review May 16, 2024 15:31
@maxnachlinger maxnachlinger changed the title rust: allow rust configuration struct to be deserialized [rust-reqwest]: allow rust configuration struct to be deserialized May 17, 2024
@wing328
Copy link
Member

wing328 commented May 27, 2024

thanks for the PR
@frol (2017/07) @farcaller (2017/08) @richardwhiuk (2019/07) @paladinzh (2020/05) @jacob-pro (2022/10)

@wing328
Copy link
Member

wing328 commented May 27, 2024

@maxnachlinger when you've time. can you please PM me via Slack to further discuss your Rust-related PRs? Thanks.

https://join.slack.com/t/openapi-generator/shared_invite/zt-12jxxd7p2-XUeQM~4pzsU9x~eGLQqX2g

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