Created by: jmini
PR checklist
-
Read the contribution guidelines. -
Ran the shell script under ./bin/
to update Petstore sample so that CIs can verify the change. (For instance, only need to run./bin/{LANG}-petstore.sh
,./bin/openapi3/{LANG}-petstore.sh
if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in.\bin\windows\
. If contributing template-only or documentation-only changes which will change sample output, be sure to build the project first. -
Filed the PR against the correct branch: master
,4.1.x
,5.0.x
. Default:master
. -
Copied the technical committee to review the pull request if your PR is targeting a particular programming language. Java @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04)
Description of the PR
With PR #42, the generator in the gson
case for java-client was changed to add a constant corresponding to the @SerializedName
value. This is useful when some other code (such as an error message) says:
Please check the value of the
'firstName'
property in'User'
.
Instead of hard-coding the name of the property (firstName
in the example) in the code, referring to the constant like this:
String errorMessage = "Please check the value of the `'" + User.JSON_PROPERTY_FIRST_NAME + "'` property";
This ensures that the code will be updated when there are changes to the generated model.
This PR add similar constants:
- in the Jackson case for: ** Java-client ** JaxRS-Server
- in the Gson case for the JaxRS-Server.