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 (12,701 stars) (5,474 forks)batch import
Issue: Bughelp wanted

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

Tech stack
java
Domain
apitooling
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.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
JavaBasic understanding of swagger codegen model resolution
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
The issue is in InlineModelResolver.java around line 249 where a new reference property is created but the 'required' flag is not copied from the original inline property. Additionally, in ModelImpl.java, the required fields list is computed from properties but may have duplication. Start by examining the linked lines in both files to understand the current behavior and then implement the fix to copy the 'required' parameter.
[codegen] InlineModelResolver doesn't copy `required` parameter to new reference property · swagger-api/swagger-codegen#4296 | Good First Issue