swagger-api/swagger-codegen

[codegen] InlineModelResolver doesn't copy `required` parameter to new reference property

Open

#4,296 opened on Nov 30, 2016

View on GitHub
 (2 comments) (0 reactions) (0 assignees)HTML (5,474 forks)batch import
Issue: Bughelp wanted

Repository metrics

Stars
 (12,701 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Description

https://github.com/swagger-api/swagger-codegen/blob/v2.2.1/modules/swagger-codegen/src/main/java/io/swagger/codegen/InlineModelResolver.java#L249 Here new reference property is created instead on inline object property. But flag required is not copied to newly created property definition. It leads that generated model is not relevant to swagger description.

Also in ModelImpl - https://github.com/swagger-api/swagger-core/blob/v1.5.10/modules/swagger-models/src/main/java/io/swagger/models/ModelImpl.java#L176 the list of required fields is calculated according to properties, not appropriate variable - https://github.com/swagger-api/swagger-core/blob/v1.5.10/modules/swagger-models/src/main/java/io/swagger/models/ModelImpl.java#L22 It looks like data duplication (list and value in properties), I would remove the list.

Swagger-codegen version

2.2.1 and current master

Contributor guide

Research direction
Inspect InlineModelResolver.java line 249 and trace the creation of reference properties to ensure the 'required' flag is copied. Also review ModelImpl.java to understand if the required list is duplicative.
Tech stack
java
Domain
apibackendtooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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
GitJava
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50