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: fix rust generation of optional additionalProperties in openapi 3.1.0 #16143

Merged
merged 3 commits into from
Jul 25, 2023

Conversation

tommilligan
Copy link
Contributor

@tommilligan tommilligan commented Jul 20, 2023

Closes #16119

cc Rust technical committee: @frol @farcaller @richardwhiuk @paladinzh @jacob-pro

Fixes code generation for rust client models, when the generated type of the subfield is optional with additionalProperties, in openapi 3.1.0

This PR inserts a default value None for the generated type Option<Option<HashMap<K, V>>> to fix what is currently a compilation error (please see #16119 for details, and reproducing the original issue).

The root cause of the above bug seems to be that in the mustache template, Option<T> seems to be considered sometimes isContainer: true and sometimes isContainer: false depending on the value of T, leading to unexpected behaviour.

This PR also contains a regression test for the issue, and adds this regression test to the relevant CI job. Please advise if this should be located/structured differently - I see modules/openapi-generator/src/test/resources/bugs already exists, but could not see it referenced in CI anywhere.

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/utils/export_docs_generators.sh
    
    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*.
    For Windows users, please run the script in Git BASH.
  • In case you are adding a new generator, run the following additional script :
    ./bin/utils/ensure-up-to-date
    
    Commit all changed files.
  • File the PR against the correct branch: master (6.3.0) (minor release - breaking changes with fallbacks), 7.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.

@@ -3,12 +3,14 @@ name: Samples Rust
on:
push:
paths:
- 'samples/client/petstore/rust/**'
- 'samples/server/petstore/rust-server/**'
- "samples/client/other/rust/**"
Copy link
Member

Choose a reason for hiding this comment

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

i think it should be others instead of other. Same for below line 11.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah yes excellent spot. Corrected

@tommilligan tommilligan requested a review from wing328 July 23, 2023 13:52
@wing328 wing328 merged commit f32be9d into OpenAPITools:master Jul 25, 2023
14 checks passed
@wing328
Copy link
Member

wing328 commented Jan 21, 2024

FYI. I've filed #17624 to fix the map, free form object detection.

there's a slight change in the rust sample output and it compiles without issue. (I've update the model template in rust client generator to properly handle free form object)

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