swagger-api/swagger-codegen

Swagger generated code now silently ignores invalid values for enumerated types

Open

#4,119 opened on Nov 3, 2016

View on GitHub
 (3 comments) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Client: JavaFeature: EnumServer: Javahelp wanted

Description

Description

Swagger generated code now silently ignores invalid values for enumerated types.

We used to have 400 exception which was perfect: HTTP/1.1 400 Bad Request X-Powered-By: Servlet/3.0 Access-Control-Allow-Origin: * Access-Control-Allow-Methods: GET, POST, DELETE, PUT Access-Control-Allow-Headers: Content-Type Content-Length: 533 Content-Type: text/plain Content-Language: en-AU Connection: Close Date: Thu, 03 Nov 2016 05:38:45 GMT

The supplied JSON was not well formed: Can not construct instance of.....

Swagger-codegen version

2.2.2-SNAPSHOT

Command line used for generation

Java, Jersey 2, jaxrs

Steps to reproduce

that code is the issue I think. @JsonCreator public static XXXEnum fromValue(String text) { for (XXXEnum b : XXXEnum.values()) { if (String.valueOf(b.value).equals(text)) { return b; } } return null; }

Suggest a Fix

I think this is a key functionality that cannot be changed. Several projects relying on that validation Please revert the changes.

Contributor guide

Tech stack
javarest api
Domain
apibackend
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
JavaJAX RSSwagger codegen basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
The issue reports that Swagger codegen's generated enum deserialization returns null instead of throwing a 400 error for invalid values. The suggested fix is to revert the change in the template that silently ignores invalid enums. Look at the codegen templates for Java JAX RS, specifically the enum serialization/deserialization code (e.g., in DefaultCodegen or template files). Check if the behavior has been reverted or if a similar fix has been applied in later versions. The issue is old, so confirm the current state of the codebase and consider updating the relevant template to restore the 400 error behavior.
Swagger generated code now silently ignores invalid values for enumerated types · swagger-api/swagger-codegen#4119 | Good First Issue