swagger-api/swagger-codegen

Enum values OFF and ON not getting generated properly.

Open

#2,559 opened on Apr 11, 2016

View on GitHub
 (6 comments) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Enhancement: FeatureFeature: Enumhelp wanted

Description

I observed this weird issue today when generating java client using maven codegen plugin, that enum values like OFF and ON are somehow ignored. Lets say in my YAML definition, there is:

laziness:
        description: Flag to denote whether laziness should be enabled or disabled.
        type: string
        enum: [ ON, OFF ]

In the above scenario, no enum type is generated, and the class member laziness have the type String. But, If the definition was as follows:

laziness:
        description: Flag to denote whether laziness should be enabled or disabled.
        type: string
        enum: [ ON, OFF, MEH ]

Codegen generates the enum with just one value - MEH, and the class member is assigned the enum type.

But if I put quotes around them, like:

laziness:
        description: Flag to denote whether laziness should be enabled or disabled.
        type: string
        enum: [ "ON", "OFF", "MEH" ]

All values are included in the generated enum.

I use the latest version of swagger-codegen-maven-plugin, version 2.1.6

PS: It works perfectly when generating from editor.swagger.io

Contributor guide

Tech stack
javarest api
Domain
toolingapi
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with JavaUnderstanding of YAMLSwagger/OpenAPI spec knowledgeMaven plugin configuration
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Investigate the Swagger Codegen's YAML parser to understand how enum values are read. Focus on the Java code generator's handling of enum types. Check if the issue is due to reserved words like 'ON' and 'OFF' being treated as boolean values. Look at the swagger codegen test cases for enum generation. Also, verify if the issue persists in the current version of the tool (now OpenAPI Generator). Refer to the source code in modules/swagger codegen/src/main/java/io/swagger/codegen/ and related parsers.