Skip to content

Conversation

@sjoubert
Copy link
Contributor

@sjoubert sjoubert commented Aug 7, 2024

This allows overriders to have full access to the response object and more finely control the error handling behavior.
For example, this enables the specification of a proper Content-Type header in case of custom format responses (application/json, application/problem+json,...)

This should be backward compatible, providing a second overloaded version with full response access to chose from if needed. The new version taking priority if both overloads are overridden.

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. @ravinikam @stkrwork @etherealjoy @MartinDelille @muttleyxd
This allows overriders to have full access to the response object and more finely control the error handling behavior. For example, this enables the specification of a proper Content-Type in case of custom format responses (application/json, ...)
Copy link
Contributor

@muttleyxd muttleyxd left a comment

Choose a reason for hiding this comment

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

Nice idea, looks good to me

@wing328 wing328 merged commit 8af3ff2 into OpenAPITools:master Aug 14, 2024
@wing328 wing328 added this to the 7.8.0 milestone Aug 14, 2024
@sjoubert sjoubert deleted the pistache-error-handlers-with-response branch August 14, 2024 06:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment