Created by: Jonas1893
Related issue: #13988
This is a proposal on how to structure Response object for future 7.* generator versions. In addition to the already decoded type it also contains raw response data enabling more advanced use cases like e.g. logging of the raw (JSON) response.
This could also be backported to 6.3.* by not renaming body and instead adding a new property bodyData instead, still the naming suggested here for 7.* makes more sense to me (ymmv of course, please share your thoughts)
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: 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./mvnw clean package ./bin/generate-samples.sh ./bin/utils/export_docs_generators.sh./bin/generate-samples.sh bin/configs/java*. For Windows users, please run the script in Git BASH. -
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. -> @jgavris (2017/07) @ehyche (2017/08) @Edubits (2017/09) @jaz-ah (2017/09) @4brunu (2019/11)
Declaration
The program was tested solely for our own use cases, which might differ from yours.