wing328
commented
4 years ago Given the following parameter description (which describes the same HTTP request payload):
parameters:
- name: body
in: body
description: Input string as post body
schema:
$ref: '#/definitions/StringRegex' parameters:
- name: body
in: body
description: Input string as post body
schema:
type: string
pattern: '^\d{3}-\d{2}-\d{4}$'Are you saying defining the schema (string with pattern in this case) inline or using $ref should generate the code differently?
jimschubert
spacether
Is your feature request related to a problem? Please describe.
When a spec with primitive models(type=string/number/integer/boolean) then that model's validations are not included when the model for that type is generated in Java.
Looking at this samples spec:
Our produced model will keep the enums in the StringEnum model, but it will discard and not store the pattern in the StringRegex model because we store no validation information in CodegenModel.
Some information on isAlias: we have the flag generateAliasAsModel defined here https://github.com/OpenAPITools/openapi-generator/blob/b69b8cdd31aef20bf41022d84df08bc62aca747e/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenConstants.java#L314 described as "Generate alias to map, array as models" however some generators also use it to generate models for primitive type. For example the Python generator sets model.isAlias=true for StringRegex when using the Python client generator model.isAlias is turned on if the name of the model is in the typeAliases https://github.com/OpenAPITools/openapi-generator/blob/d7b390f328a597438edd6a72a9f1ff495ca7080a/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java#L1695 typeAliases are generated here: https://github.com/OpenAPITools/openapi-generator/blob/d7b390f328a597438edd6a72a9f1ff495ca7080a/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java#L1667 Items are added to typeAliases here: https://github.com/OpenAPITools/openapi-generator/blob/d7b390f328a597438edd6a72a9f1ff495ca7080a/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java#L3692
Whether or not primitive models have isAlias turned on, having the validation info would let us include it in produced models.
Describe the solution you'd like
The included spec passes validation at https://apitools.dev/swagger-parser/online/ How about we include primitive model validation information in the CodegenModel class. Then we can leave it up to the devs to see if they want to produce models which include this validation info.
Reasons why this would help:
Spec Information
Prior Related Work:
Describe alternatives you've considered
One alternative is to move this primitive schema into a property and load that property into an object model. The python-experimental generator does that but it is overly complicated for a feature that the Swagger and Openapi spec supports.
Additional context
Here is the debug info when using the python generator with -DdebugSupportingFiles The StringRegex model is omitted by the generator
Core Team @wing328 (2015/07) @jimschubert (2016/05) @cbornet (2016/05) @ackintosh (2018/02) @jmini (2018/04) @etherealjoy (2019/06)
Java Team @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10)