Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Moves discriminator into discriminator() class method, adds test_dese…
…rialize_lizard, adds setting discriminator using allOf schema
  • Loading branch information
spacether committed Dec 8, 2019
commit f5fec628dd842f8fd98e34dc3a04fb421bcb9743
Original file line number Diff line number Diff line change
Expand Up @@ -1807,17 +1807,22 @@ public CodegenModel fromModel(String name, Schema schema) {
m.allVars = new ArrayList<CodegenProperty>();
if (composed.getAllOf() != null) {
int modelImplCnt = 0; // only one inline object allowed in a ComposedModel
int modelDiscriminators = 0; // only one discriminator allowed in a ComposedModel
for (Schema innerSchema : composed.getAllOf()) { // TOOD need to work with anyOf, oneOf as well
if (m.discriminator == null) {
if (m.discriminator == null && innerSchema.getDiscriminator() != null) {
LOGGER.debug("discriminator is set to null (not correctly set earlier): {}", name);
m.discriminator = createDiscriminator(name, schema);
m.discriminator = createDiscriminator(name, innerSchema);
Copy link
Contributor Author

@spacether spacether Dec 8, 2019

Choose a reason for hiding this comment

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

Per here: https://swagger.io/specification/#discriminatorObject
We should be able to set the discriminator on the parent composed schema, but that's not yet working because of this bug in swagger parser: swagger-api/swagger-parser#1269
In place of having discriminator at the root level of a composed schema, we should be able to use it from our definition in our allOf schemas.
I updated this code to set the discriminator on self if one of its ancestor allOf schemas defines discriminator.
Please see my ParentPet class which demonstrates this usage at: https://github.com/spacether/openapi-generator/blob/allof_anyof_oneof_addition/modules/openapi-generator/src/test/resources/2_0/python-client-experimental/petstore-with-fake-endpoints-models-for-testing.yaml#L2072

NOTE: the original invocation here m.discriminator = createDiscriminator(name, schema); did not do anything because we already ran that exact line above in line 1772.

Copy link
Member

Choose a reason for hiding this comment

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

I think this seems reasonable, but I'd like to have someone else on the @OpenAPITools/generator-core-team review as well since it affects all generators.

modelDiscriminators++;
}

if (innerSchema.getXml() != null) {
m.xmlPrefix = innerSchema.getXml().getPrefix();
m.xmlNamespace = innerSchema.getXml().getNamespace();
m.xmlName = innerSchema.getXml().getName();
}
if (modelDiscriminators > 1) {
LOGGER.error("Allof composed schema is inherriting >1 descriminator. Only use one discriminator: {}", composed);
}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We should error out if the user tries to define multiple discriminators in one schema.


if (modelImplCnt++ > 1) {
LOGGER.warn("More than one inline schema specified in allOf:. Only the first one is recognized. All others are ignored.");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,17 @@

additional_properties_type = {{#additionalPropertiesType}}({{{additionalPropertiesType}}},) # noqa: E501{{/additionalPropertiesType}}{{^additionalPropertiesType}}None{{/additionalPropertiesType}}

discriminator = {{^discriminator}}None{{/discriminator}}{{#discriminator}}{
'{{{discriminatorName}}}': {
@staticmethod
def discriminator():
return {{^discriminator}}None{{/discriminator}}{{#discriminator}}{
'{{{discriminatorName}}}': {
{{#children}}
'{{^vendorExtensions.x-discriminator-value}}{{name}}{{/vendorExtensions.x-discriminator-value}}{{#vendorExtensions.x-discriminator-value}}{{{vendorExtensions.x-discriminator-value}}}{{/vendorExtensions.x-discriminator-value}}': {{{classname}}},
'{{^vendorExtensions.x-discriminator-value}}{{name}}{{/vendorExtensions.x-discriminator-value}}{{#vendorExtensions.x-discriminator-value}}{{{vendorExtensions.x-discriminator-value}}}{{/vendorExtensions.x-discriminator-value}}': {{{classname}}},
{{/children}}
},
}{{/discriminator}}
{{^children}}
{{#mappedModels}}
'{{mappingName}}': {{{modelName}}},
{{/mappedModels}}
{{/children}}
},
}{{/discriminator}}
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
@classmethod
def get_discriminator_class(cls, from_server, data):
"""Returns the child class specified by the discriminator"""
discr_propertyname_py = list(cls.discriminator.keys())[0]
discriminator = cls.discriminator()
discr_propertyname_py = list(discriminator.keys())[0]
discr_propertyname_js = cls.attribute_map[discr_propertyname_py]
if from_server:
class_name = data[discr_propertyname_js]
else:
class_name = data[discr_propertyname_py]
class_name_to_discr_class = cls.discriminator[discr_propertyname_py]
class_name_to_discr_class = discriminator[discr_propertyname_py]
return class_name_to_discr_class.get(class_name)
Original file line number Diff line number Diff line change
Expand Up @@ -591,7 +591,7 @@ def deserialize_model(model_data, model_class, path_to_item, check_type,
_from_server=from_server)

used_model_class = model_class
if model_class.discriminator is not None:
if model_class.discriminator() is not None:
used_model_class = model_class.get_discriminator_class(
from_server, model_data)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2071,9 +2071,10 @@ definitions:
type: string
ParentPet:
type: object
discriminator: pet_type
allOf:
- $ref: '#/definitions/GrandparentAnimal'
- type: object
discriminator: pet_type
ChildCat:
allOf:
- $ref: '#/definitions/ParentPet'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -844,7 +844,7 @@ def deserialize_model(model_data, model_class, path_to_item, check_type,
_from_server=from_server)

used_model_class = model_class
if model_class.discriminator is not None:
if model_class.discriminator() is not None:
used_model_class = model_class.get_discriminator_class(
from_server, model_data)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ class AdditionalPropertiesAnyType(ModelNormal):

additional_properties_type = (bool, date, datetime, dict, float, int, list, str,) # noqa: E501

discriminator = None
@staticmethod
def discriminator():
return None

attribute_map = {
'name': 'name', # noqa: E501
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ class AdditionalPropertiesArray(ModelNormal):

additional_properties_type = ([bool, date, datetime, dict, float, int, list, str],) # noqa: E501

discriminator = None
@staticmethod
def discriminator():
return None

attribute_map = {
'name': 'name', # noqa: E501
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ class AdditionalPropertiesBoolean(ModelNormal):

additional_properties_type = (bool,) # noqa: E501

discriminator = None
@staticmethod
def discriminator():
return None

attribute_map = {
'name': 'name', # noqa: E501
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,9 @@ class AdditionalPropertiesClass(ModelNormal):

additional_properties_type = None

discriminator = None
@staticmethod
def discriminator():
return None

attribute_map = {
'map_string': 'map_string', # noqa: E501
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ class AdditionalPropertiesInteger(ModelNormal):

additional_properties_type = (int,) # noqa: E501

discriminator = None
@staticmethod
def discriminator():
return None

attribute_map = {
'name': 'name', # noqa: E501
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ class AdditionalPropertiesNumber(ModelNormal):

additional_properties_type = (float,) # noqa: E501

discriminator = None
@staticmethod
def discriminator():
return None

attribute_map = {
'name': 'name', # noqa: E501
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ class AdditionalPropertiesObject(ModelNormal):

additional_properties_type = ({str: (bool, date, datetime, dict, float, int, list, str,)},) # noqa: E501

discriminator = None
@staticmethod
def discriminator():
return None

attribute_map = {
'name': 'name', # noqa: E501
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ class AdditionalPropertiesString(ModelNormal):

additional_properties_type = (str,) # noqa: E501

discriminator = None
@staticmethod
def discriminator():
return None

attribute_map = {
'name': 'name', # noqa: E501
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,12 +77,14 @@ class Animal(ModelNormal):

additional_properties_type = None

discriminator = {
'class_name': {
'Cat': cat.Cat,
'Dog': dog.Dog,
},
}
@staticmethod
def discriminator():
return {
'class_name': {
'Cat': cat.Cat,
'Dog': dog.Dog,
},
}

attribute_map = {
'class_name': 'className', # noqa: E501
Expand Down Expand Up @@ -137,11 +139,12 @@ def __init__(self, class_name, _check_type=True, _from_server=False, _path_to_it
@classmethod
def get_discriminator_class(cls, from_server, data):
"""Returns the child class specified by the discriminator"""
discr_propertyname_py = list(cls.discriminator.keys())[0]
discriminator = cls.discriminator()
discr_propertyname_py = list(discriminator.keys())[0]
discr_propertyname_js = cls.attribute_map[discr_propertyname_py]
if from_server:
class_name = data[discr_propertyname_js]
else:
class_name = data[discr_propertyname_py]
class_name_to_discr_class = cls.discriminator[discr_propertyname_py]
class_name_to_discr_class = discriminator[discr_propertyname_py]
return class_name_to_discr_class.get(class_name)
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,9 @@ class ApiResponse(ModelNormal):

additional_properties_type = None

discriminator = None
@staticmethod
def discriminator():
return None

attribute_map = {
'code': 'code', # noqa: E501
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ class ArrayOfArrayOfNumberOnly(ModelNormal):

additional_properties_type = None

discriminator = None
@staticmethod
def discriminator():
return None

attribute_map = {
'array_array_number': 'ArrayArrayNumber', # noqa: E501
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ class ArrayOfNumberOnly(ModelNormal):

additional_properties_type = None

discriminator = None
@staticmethod
def discriminator():
return None

attribute_map = {
'array_number': 'ArrayNumber', # noqa: E501
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,9 @@ class ArrayTest(ModelNormal):

additional_properties_type = None

discriminator = None
@staticmethod
def discriminator():
return None

attribute_map = {
'array_of_string': 'array_of_string', # noqa: E501
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,9 @@ class Capitalization(ModelNormal):

additional_properties_type = None

discriminator = None
@staticmethod
def discriminator():
return None

attribute_map = {
'small_camel': 'smallCamel', # noqa: E501
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,9 @@ class Cat(ModelComposed):

additional_properties_type = None

discriminator = None
@staticmethod
def discriminator():
return None

attribute_map = {
'class_name': 'className', # noqa: E501
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ class CatAllOf(ModelNormal):

additional_properties_type = None

discriminator = None
@staticmethod
def discriminator():
return None

attribute_map = {
'declawed': 'declawed', # noqa: E501
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,9 @@ class Category(ModelNormal):

additional_properties_type = None

discriminator = None
@staticmethod
def discriminator():
return None

attribute_map = {
'name': 'name', # noqa: E501
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,9 @@ class Child(ModelComposed):

additional_properties_type = None

discriminator = None
@staticmethod
def discriminator():
return None

attribute_map = {
'radio_waves': 'radioWaves', # noqa: E501
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ class ChildAllOf(ModelNormal):

additional_properties_type = None

discriminator = None
@staticmethod
def discriminator():
return None

attribute_map = {
'inter_net': 'interNet', # noqa: E501
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,9 @@ class ChildCat(ModelComposed):

additional_properties_type = None

discriminator = None
@staticmethod
def discriminator():
return None

attribute_map = {
'pet_type': 'pet_type', # noqa: E501
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ class ChildCatAllOf(ModelNormal):

additional_properties_type = None

discriminator = None
@staticmethod
def discriminator():
return None

attribute_map = {
'name': 'name', # noqa: E501
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,9 @@ class ChildDog(ModelComposed):

additional_properties_type = None

discriminator = None
@staticmethod
def discriminator():
return None

attribute_map = {
'pet_type': 'pet_type', # noqa: E501
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ class ChildDogAllOf(ModelNormal):

additional_properties_type = None

discriminator = None
@staticmethod
def discriminator():
return None

attribute_map = {
'bark': 'bark', # noqa: E501
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,9 @@ class ChildLizard(ModelComposed):

additional_properties_type = None

discriminator = None
@staticmethod
def discriminator():
return None

attribute_map = {
'pet_type': 'pet_type', # noqa: E501
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ class ChildLizardAllOf(ModelNormal):

additional_properties_type = None

discriminator = None
@staticmethod
def discriminator():
return None

attribute_map = {
'loves_rocks': 'lovesRocks', # noqa: E501
Expand Down
Loading