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] [Breaking Changes] Prevent Operation response with internal Error #20047

Merged
merged 2 commits into from
Nov 7, 2024

Conversation

linxGnu
Copy link
Contributor

@linxGnu linxGnu commented Nov 7, 2024

For security reason, Operation should not return Internal Server Error to client. User of Rust-Axum can custom this behavior by custom templates.

However, as default, should prevent!

Integration tests passed:

mvn clean && ./bin/generate-samples.sh bin/configs/manual/rust-axum-*
mvn integration-test -f samples/server/petstore/rust-axum/pom.xml

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.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.

@@ -72,7 +72,7 @@ pub trait {{classnamePascalCase}} {
{{#x-consumes-multipart-related}}
body: axum::body::Body,
{{/x-consumes-multipart-related}}
) -> Result<{{{operationId}}}Response, String>;
) -> Result<{{{operationId}}}Response, ()>;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Kindly ping @wing328 to review

This is interface/trait update. The other changed-files are generated samples.

Copy link
Member

Choose a reason for hiding this comment

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

thanks for the heads-up

if users need a way to rollback, we can then provide an option or the users can simply use custom templates for the time being.

@wing328 wing328 added this to the 7.10.0 milestone Nov 7, 2024
@wing328 wing328 merged commit cfef948 into OpenAPITools:master Nov 7, 2024
20 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.

2 participants