-
-
Notifications
You must be signed in to change notification settings - Fork 6.7k
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
[Java][okhttp-gson] validateJsonElement does not validate enum values #16865
Merged
wing328
merged 3 commits into
OpenAPITools:master
from
ctreatma:okhttp-gson-enum-validation
Nov 8, 2023
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
123 changes: 123 additions & 0 deletions
123
modules/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/modelEnum.mustache
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| {{#jackson}} | ||
| import com.fasterxml.jackson.annotation.JsonCreator; | ||
| import com.fasterxml.jackson.annotation.JsonValue; | ||
| {{/jackson}} | ||
| {{#gson}} | ||
| import java.io.IOException; | ||
| import com.google.gson.TypeAdapter; | ||
| import com.google.gson.JsonElement; | ||
| import com.google.gson.annotations.JsonAdapter; | ||
| import com.google.gson.stream.JsonReader; | ||
| import com.google.gson.stream.JsonWriter; | ||
| {{/gson}} | ||
|
|
||
| /** | ||
| * {{description}}{{^description}}Gets or Sets {{{name}}}{{/description}} | ||
| */ | ||
| {{#gson}} | ||
| @JsonAdapter({{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}}.Adapter.class) | ||
| {{/gson}} | ||
| {{#jsonb}} | ||
| @JsonbTypeSerializer({{datatypeWithEnum}}.Serializer.class) | ||
| @JsonbTypeDeserializer({{datatypeWithEnum}}.Deserializer.class) | ||
| {{/jsonb}} | ||
| {{>additionalEnumTypeAnnotations}}public enum {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}} { | ||
| {{#allowableValues}}{{#enumVars}} | ||
| {{#enumDescription}} | ||
| /** | ||
| * {{.}} | ||
| */ | ||
| {{/enumDescription}} | ||
| {{#withXml}} | ||
| @XmlEnumValue({{#isInteger}}"{{/isInteger}}{{#isDouble}}"{{/isDouble}}{{#isLong}}"{{/isLong}}{{#isFloat}}"{{/isFloat}}{{{value}}}{{#isInteger}}"{{/isInteger}}{{#isDouble}}"{{/isDouble}}{{#isLong}}"{{/isLong}}{{#isFloat}}"{{/isFloat}}) | ||
| {{/withXml}} | ||
| {{{name}}}({{{value}}}){{^-last}}, | ||
| {{/-last}}{{#-last}};{{/-last}}{{/enumVars}}{{/allowableValues}} | ||
|
|
||
| private {{{dataType}}} value; | ||
|
|
||
| {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}}({{{dataType}}} value) { | ||
| this.value = value; | ||
| } | ||
|
|
||
| {{#jackson}} | ||
| @JsonValue | ||
| {{/jackson}} | ||
| public {{{dataType}}} getValue() { | ||
| return value; | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return String.valueOf(value); | ||
| } | ||
|
|
||
| {{#jackson}} | ||
| @JsonCreator | ||
| {{/jackson}} | ||
| public static {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}} fromValue({{{dataType}}} value) { | ||
| for ({{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}} b : {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}}.values()) { | ||
| if (b.value.{{^isString}}equals{{/isString}}{{#isString}}{{#useEnumCaseInsensitive}}equalsIgnoreCase{{/useEnumCaseInsensitive}}{{^useEnumCaseInsensitive}}equals{{/useEnumCaseInsensitive}}{{/isString}}(value)) { | ||
| return b; | ||
| } | ||
| } | ||
| {{#isNullable}}return null;{{/isNullable}}{{^isNullable}}{{#enumUnknownDefaultCase}}{{#allowableValues}}{{#enumVars}}{{#-last}}return {{{name}}};{{/-last}}{{/enumVars}}{{/allowableValues}}{{/enumUnknownDefaultCase}}{{^enumUnknownDefaultCase}}throw new IllegalArgumentException("Unexpected value '" + value + "'");{{/enumUnknownDefaultCase}}{{/isNullable}} | ||
| } | ||
| {{#gson}} | ||
|
|
||
| public static class Adapter extends TypeAdapter<{{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}}> { | ||
| @Override | ||
| public void write(final JsonWriter jsonWriter, final {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}} enumeration) throws IOException { | ||
| jsonWriter.value(enumeration.getValue()); | ||
| } | ||
|
|
||
| @Override | ||
| public {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}} read(final JsonReader jsonReader) throws IOException { | ||
| {{^isNumber}}{{{dataType}}}{{/isNumber}}{{#isNumber}}String{{/isNumber}} value = jsonReader.{{#isNumber}}nextString(){{/isNumber}}{{#isInteger}}nextInt(){{/isInteger}}{{^isNumber}}{{^isInteger}}next{{{dataType}}}(){{/isInteger}}{{/isNumber}}; | ||
| return {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}}.fromValue({{#isNumber}}new BigDecimal({{/isNumber}}value{{#isNumber}}){{/isNumber}}); | ||
| } | ||
| } | ||
|
|
||
| public static void validateJsonElement(JsonElement jsonElement) throws IOException { | ||
| {{^isNumber}}{{{dataType}}}{{/isNumber}}{{#isNumber}}String{{/isNumber}} value = jsonElement.{{#isNumber}}getAsString(){{/isNumber}}{{#isInteger}}getAsInt(){{/isInteger}}{{^isNumber}}{{^isInteger}}getAs{{{dataType}}}(){{/isInteger}}{{/isNumber}}; | ||
| {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}}.fromValue({{#isNumber}}new BigDecimal({{/isNumber}}value{{#isNumber}}){{/isNumber}}); | ||
| } | ||
| {{/gson}} | ||
| {{#jsonb}} | ||
|
|
||
| public static final class Deserializer implements JsonbDeserializer<{{datatypeWithEnum}}> { | ||
| @Override | ||
| public {{datatypeWithEnum}} deserialize(JsonParser parser, DeserializationContext ctx, Type rtType) { | ||
| for ({{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}} b : {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}}.values()) { | ||
| if (String.valueOf(b.value).equals(parser.getString())) { | ||
| return b; | ||
| } | ||
| } | ||
| {{#useNullForUnknownEnumValue}}return null;{{/useNullForUnknownEnumValue}}{{^useNullForUnknownEnumValue}}throw new IllegalArgumentException("Unexpected value '" + parser.getString() + "'");{{/useNullForUnknownEnumValue}} | ||
| } | ||
| } | ||
|
|
||
| public static final class Serializer implements JsonbSerializer<{{datatypeWithEnum}}> { | ||
| @Override | ||
| public void serialize({{datatypeWithEnum}} obj, JsonGenerator generator, SerializationContext ctx) { | ||
| generator.write(obj.value); | ||
| } | ||
| } | ||
| {{/jsonb}} | ||
| {{#supportUrlQuery}} | ||
|
|
||
| /** | ||
| * Convert the instance into URL query string. | ||
| * | ||
| * @param prefix prefix of the query string | ||
| * @return URL query string | ||
| */ | ||
| public String toUrlQueryString(String prefix) { | ||
| if (prefix == null) { | ||
| prefix = ""; | ||
| } | ||
|
|
||
| return String.format("%s=%s", prefix, this.toString()); | ||
| } | ||
| {{/supportUrlQuery}} | ||
| } | ||
100 changes: 100 additions & 0 deletions
100
...s/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/modelInnerEnum.mustache
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| /** | ||
| * {{description}}{{^description}}Gets or Sets {{{name}}}{{/description}} | ||
| */ | ||
| {{#gson}} | ||
| @JsonAdapter({{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}.Adapter.class) | ||
| {{/gson}} | ||
| {{#jsonb}} | ||
| @JsonbTypeSerializer({{datatypeWithEnum}}.Serializer.class) | ||
| @JsonbTypeDeserializer({{datatypeWithEnum}}.Deserializer.class) | ||
| {{/jsonb}} | ||
| {{#withXml}} | ||
| @XmlType(name="{{datatypeWithEnum}}") | ||
| @XmlEnum({{dataType}}.class) | ||
| {{/withXml}} | ||
| {{>additionalEnumTypeAnnotations}}public enum {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}} { | ||
| {{#allowableValues}} | ||
| {{#enumVars}} | ||
| {{#enumDescription}} | ||
| /** | ||
| * {{.}} | ||
| */ | ||
| {{/enumDescription}} | ||
| {{#withXml}} | ||
| @XmlEnumValue({{#isInteger}}"{{/isInteger}}{{#isDouble}}"{{/isDouble}}{{#isLong}}"{{/isLong}}{{#isFloat}}"{{/isFloat}}{{{value}}}{{#isInteger}}"{{/isInteger}}{{#isDouble}}"{{/isDouble}}{{#isLong}}"{{/isLong}}{{#isFloat}}"{{/isFloat}}) | ||
| {{/withXml}} | ||
| {{{name}}}({{{value}}}){{^-last}}, | ||
| {{/-last}}{{#-last}};{{/-last}} | ||
| {{/enumVars}} | ||
| {{/allowableValues}} | ||
|
|
||
| private {{{dataType}}} value; | ||
|
|
||
| {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}({{{dataType}}} value) { | ||
| this.value = value; | ||
| } | ||
|
|
||
| {{#jackson}} | ||
| @JsonValue | ||
| {{/jackson}} | ||
| public {{{dataType}}} getValue() { | ||
| return value; | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return String.valueOf(value); | ||
| } | ||
|
|
||
| {{#jackson}} | ||
| @JsonCreator | ||
| {{/jackson}} | ||
| public static {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}} fromValue({{{dataType}}} value) { | ||
| for ({{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}} b : {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}}.values()) { | ||
| if (b.value.{{^isString}}equals{{/isString}}{{#isString}}{{#useEnumCaseInsensitive}}equalsIgnoreCase{{/useEnumCaseInsensitive}}{{^useEnumCaseInsensitive}}equals{{/useEnumCaseInsensitive}}{{/isString}}(value)) { | ||
| return b; | ||
| } | ||
| } | ||
| {{#isNullable}}return null;{{/isNullable}}{{^isNullable}}{{#enumUnknownDefaultCase}}{{#allowableValues}}{{#enumVars}}{{#-last}}return {{{name}}};{{/-last}}{{/enumVars}}{{/allowableValues}}{{/enumUnknownDefaultCase}}{{^enumUnknownDefaultCase}}throw new IllegalArgumentException("Unexpected value '" + value + "'");{{/enumUnknownDefaultCase}}{{/isNullable}} | ||
| } | ||
| {{#gson}} | ||
|
|
||
| public static class Adapter extends TypeAdapter<{{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}> { | ||
| @Override | ||
| public void write(final JsonWriter jsonWriter, final {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}} enumeration) throws IOException { | ||
| jsonWriter.value(enumeration.getValue()); | ||
| } | ||
|
|
||
| @Override | ||
| public {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}} read(final JsonReader jsonReader) throws IOException { | ||
| {{^isNumber}}{{{dataType}}}{{/isNumber}}{{#isNumber}}String{{/isNumber}} value = {{#isFloat}}(float){{/isFloat}} jsonReader.{{#isNumber}}nextString(){{/isNumber}}{{#isInteger}}nextInt(){{/isInteger}}{{^isNumber}}{{^isInteger}}{{#isFloat}}nextDouble{{/isFloat}}{{^isFloat}}next{{{dataType}}}{{/isFloat}}(){{/isInteger}}{{/isNumber}}; | ||
| return {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}.fromValue({{#isNumber}}new BigDecimal({{/isNumber}}value{{#isNumber}}){{/isNumber}}); | ||
| } | ||
| } | ||
|
|
||
| public static void validateJsonElement(JsonElement jsonElement) throws IOException { | ||
| {{^isNumber}}{{{dataType}}}{{/isNumber}}{{#isNumber}}String{{/isNumber}} value = jsonElement.{{#isNumber}}getAsString(){{/isNumber}}{{#isInteger}}getAsInt(){{/isInteger}}{{^isNumber}}{{^isInteger}}getAs{{{dataType}}}(){{/isInteger}}{{/isNumber}}; | ||
| {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}}.fromValue({{#isNumber}}new BigDecimal({{/isNumber}}value{{#isNumber}}){{/isNumber}}); | ||
| } | ||
| {{/gson}} | ||
| {{#jsonb}} | ||
| public static final class Deserializer implements JsonbDeserializer<{{datatypeWithEnum}}> { | ||
| @Override | ||
| public {{datatypeWithEnum}} deserialize(JsonParser parser, DeserializationContext ctx, Type rtType) { | ||
| for ({{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}} b : {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}}.values()) { | ||
| if (String.valueOf(b.value).equals(parser.getString())) { | ||
| return b; | ||
| } | ||
| } | ||
| {{#useNullForUnknownEnumValue}}return null;{{/useNullForUnknownEnumValue}}{{^useNullForUnknownEnumValue}}throw new IllegalArgumentException("Unexpected value '" + parser.getString() + "'");{{/useNullForUnknownEnumValue}} | ||
| } | ||
| } | ||
|
|
||
| public static final class Serializer implements JsonbSerializer<{{datatypeWithEnum}}> { | ||
| @Override | ||
| public void serialize({{datatypeWithEnum}} obj, JsonGenerator generator, SerializationContext ctx) { | ||
| generator.write(obj.value); | ||
| } | ||
| } | ||
| {{/jsonb}} | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
when you've time, can you please file another PR to clean up {{#jackson}} ... {{/jackson}} in this file as okhttp-gson library doesn't use the jackson mustache tag?
(and we don't need the gson tag either as it must be true when using okhttp-gson)