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

feat(rust): support ability to disable boxed models in client #17931

Merged
merged 2 commits into from
Feb 28, 2024

Conversation

DDtKey
Copy link
Contributor

@DDtKey DDtKey commented Feb 22, 2024

Add new additional property avoidBoxedModels which can be configured to avoid Box<..> of models.
(alternative could be boxModels that defaults to true)

It's very nice to have such config, because it doesn't make a lot of sense for really simple models.

Also it fixes undesired boxes for non-models in oneOf generation (followup after #17915 & particularly #17915 (comment)). E.g: before this PR - and after

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.

@frol @farcaller @richardwhiuk @paladinzh @jacob-pro cc @wing328

@DDtKey
Copy link
Contributor Author

DDtKey commented Feb 22, 2024

cc @RobbieMcKinstry this PR removes unnecessary Boxes for non-models in Enums.
And moreover, allows you to disable boxes at all by an additional property avoidBoxedModels.

@RobbieMcKinstry
Copy link

You rule! Very cool, thank you very much! ❤️

@DDtKey DDtKey changed the title feat(client): support ability to disable boxed models feat(rust): support ability to disable boxed models in client Feb 23, 2024
Add new additional property `avoidBoxedModels` which can be configured to avoid `Box<..>` of models.

It's very nice to have such config, because it doesn't make a lot of sense for really simple models.
@DDtKey DDtKey marked this pull request as ready for review February 24, 2024 17:49
@DDtKey
Copy link
Contributor Author

DDtKey commented Feb 24, 2024

I rebased this one onto master branch, because #17915 has been merged.
So now it's ready to review!

@DDtKey
Copy link
Contributor Author

DDtKey commented Feb 26, 2024

@wing328 sorry for direct mentioning, but just wondering if it's possible to incorporate this change as part of 7.4.0?

It's a good addition to already merged #17915 and should compatible with existed behavior because of default value of the new property.

@wing328
Copy link
Member

wing328 commented Feb 28, 2024

lgtm. thanks for the PR. let's give it a try

@wing328 wing328 merged commit 4b04e17 into OpenAPITools:master Feb 28, 2024
18 checks passed
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