swagger-api/swagger-codegen

Enum values OFF and ON not getting generated properly.

Open

#2 559 ouverte le 11 avr. 2016

Voir sur GitHub
 (6 commentaires) (0 réactions) (0 assignés)HTML (5 474 forks)batch import
Enhancement: FeatureFeature: Enumhelp wanted

Métriques du dépôt

Stars
 (12 701 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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

Guide contributeur

Direction de recherche
Examinez comment l'analyseur de Swagger codegen traite les valeurs d'énumération sans guillemets, en particulier 'ON' et 'OFF', qui peuvent être confondues avec des valeurs booléennes ou des mots réservés. Consultez la logique d'analyse pour l'extraction des énumérations et le modèle de génération pour comprendre pourquoi elles sont ignorées. Comparez le comportement avec les valeurs entre guillemets pour identifier la différence d'analyse.
Stack technique
java
Domaine
apibackendtooling
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
JavaOpenAPI/Swagger specMaven
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65