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

Fix rust axum doc tests (#19538) #19539

Merged
merged 1 commit into from
Oct 3, 2024

Conversation

faro-dr
Copy link
Contributor

@faro-dr faro-dr commented Sep 6, 2024

Fixes the Rust doc tests generated by rust-axum. The doc tests used an invalid should_panic attribute, probably a typo.

For reference, this is how a doc test that is expected to panic should look like: https://doc.rust-lang.org/rustdoc/write-documentation/documentation-tests.html#attributes

Sorry for not providing a minimal OpenAPI spec to reproduce the issue but I think the problem is obvious and the fix is trivial enough.

@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 
    ./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.6.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 Sep 7, 2024

@faro-dr thanks for the PR

cc @linxGnu

Copy link
Contributor

@linxGnu linxGnu left a comment

Choose a reason for hiding this comment

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

LGTM. I apologize for late reply due to personal matters.

@wing328 wing328 merged commit d193050 into OpenAPITools:master Oct 3, 2024
10 checks passed
@wing328
Copy link
Member

wing328 commented Oct 3, 2024

@linxGnu @faro-dr I updated the samples via 577483c but CI reported errors: https://github.com/OpenAPITools/openapi-generator/actions/runs/11158288924/job/31014249053

can you please take a look when you've time?

@faro-dr faro-dr deleted the fix-rust-axum-doc-test-19538 branch October 8, 2024 07:07
@faro-dr
Copy link
Contributor Author

faro-dr commented Oct 8, 2024

@wing328 I just had a look at 577483c: it contains more changes than just those introduced by this PR. Apparently, some type models::FormTestRequest is missing/wasn't generated but I'm quite sure it isn't caused by this PR.

@linxGnu
Copy link
Contributor

linxGnu commented Oct 20, 2024

@faro-dr
Seem like there are changes in the sample inputs and require us to set:

globalProperties:
  skipFormModel: "false"

Fixed with: #19920

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