Skip to content

Fix for issue 835 #836

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 12, 2018
Merged

Fix for issue 835 #836

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
156 changes: 94 additions & 62 deletions ...er-parser-v2-converter/src/main/java/io/swagger/v3/parser/converter/SwaggerConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,8 @@ public SwaggerParseResult convert(SwaggerDeserializationResult parse) {
if ("body".equals(v.getIn())) {
components.addRequestBodies(k, convertParameterToRequestBody(v));
} else if ("formData".equals(v.getIn())) {
components.addRequestBodies(k, convertFormDataToRequestBody(v));
// formData_ is added not to overwrite existing schemas
components.addSchemas("formData_" + k, convertFormDataToSchema(v));
} else {
components.addParameters(k, convert(v));
}
Expand Down Expand Up @@ -529,6 +530,16 @@ private boolean isRefABodyParam(io.swagger.models.parameters.Parameter param) {
return false;
}

private boolean isRefAFormParam(io.swagger.models.parameters.Parameter param) {
if (param instanceof RefParameter) {
RefParameter refParameter = (RefParameter) param;
String simpleRef = refParameter.getSimpleRef();
io.swagger.models.parameters.Parameter parameter = globalV2Parameters.get(simpleRef);
return "formData".equals(parameter.getIn());
}
return false;
}

public Operation convert(io.swagger.models.Operation v2Operation) {
Operation operation = new Operation();
if (StringUtils.isNotBlank(v2Operation.getDescription())) {
Expand All @@ -555,10 +566,11 @@ public Operation convert(io.swagger.models.Operation v2Operation) {
String $ref = convert.get$ref();
if ($ref != null && $ref.startsWith("#/components/requestBodies/") && isRefABodyParam(param)) {
operation.setRequestBody(new RequestBody().$ref($ref));
} else if ($ref != null && $ref.startsWith("#/components/schemas/") && isRefAFormParam(param)) {
formParams.add(param);
} else {
operation.addParametersItem(convert);
}
//operation.addParametersItem(convert(param));
}
}

Expand Down Expand Up @@ -611,8 +623,9 @@ private Map<String, Object> convert(Map<String, Object> vendorExtensions) {
return vendorExtensions;
}

private RequestBody convertFormDataToRequestBody(io.swagger.models.parameters.Parameter formParam) {
return convertFormDataToRequestBody(Arrays.asList(formParam), null);
private Schema convertFormDataToSchema(io.swagger.models.parameters.Parameter formParam) {
SerializableParameter sp = (SerializableParameter) formParam;
return convert(sp);
}

private RequestBody convertFormDataToRequestBody(List<io.swagger.models.parameters.Parameter> formParams, List<String> consumes) {
Expand All @@ -621,73 +634,27 @@ private RequestBody convertFormDataToRequestBody(List<io.swagger.models.paramete
Schema formSchema = new Schema();

for (io.swagger.models.parameters.Parameter param : formParams) {
SerializableParameter sp = (SerializableParameter) param;
SerializableParameter sp;

Schema schema;
if ("file".equals(sp.getType())) {
schema = new FileSchema();
} else if ("array".equals(sp.getType())) {
ArraySchema as = new ArraySchema();
if (sp.getItems() != null) {
as.setItems(convert(sp.getItems()));
}
schema = as;
String name;
if (param instanceof RefParameter) {
RefParameter refParameter = (RefParameter) param;
String simpleRef = refParameter.getSimpleRef();
sp = (SerializableParameter) globalV2Parameters.get(simpleRef);
name = components.getSchemas().get("formData_" + simpleRef).getName();
schema = new Schema().$ref("#/components/schemas/formData_" + simpleRef);
} else {
schema = new Schema();
schema.setType(sp.getType());
schema.setFormat(sp.getFormat());
}

schema.setDescription(sp.getDescription());
schema.setReadOnly(sp.isReadOnly());
schema.setEnum(sp.getEnum());

if (sp.getMaxItems() != null) {
schema.setMaxItems(sp.getMaxItems());
}
if (sp.getMinItems() != null) {
schema.setMinItems(sp.getMinItems());
}
if (sp.isUniqueItems() != null) {
schema.setUniqueItems(sp.isUniqueItems());
}

schema.setMaximum(sp.getMaximum());
schema.setExclusiveMaximum(sp.isExclusiveMaximum());
schema.setMinimum(sp.getMinimum());
schema.setExclusiveMinimum(sp.isExclusiveMinimum());
schema.setMinLength(sp.getMinLength());
schema.setMaxLength(sp.getMaxLength());

if (sp.getVendorExtensions() != null) {
Object exampleExtension = sp.getVendorExtensions().get("x-example");
if (exampleExtension != null) {
schema.setExample(exampleExtension);
}
Object nullableExtension = sp.getVendorExtensions().get("x-nullable");
if (nullableExtension != null) {
schema.setNullable((Boolean) nullableExtension);
}
schema.setExtensions(convert(sp.getVendorExtensions()));
}

if (sp.getMultipleOf() != null) {
schema.setMultipleOf(new BigDecimal(sp.getMultipleOf().toString()));
}

schema.setPattern(sp.getPattern());
schema.setExtensions(convert(sp.getVendorExtensions()));

if (sp instanceof AbstractSerializableParameter) {
AbstractSerializableParameter ap = (AbstractSerializableParameter) sp;
schema.setDefault(ap.getDefault());
sp = (SerializableParameter) param;
schema = convert(sp);
name = schema.getName();
}

if (sp.getRequired()) {
formSchema.addRequiredItem(sp.getName());
}

formSchema.addProperties(param.getName(), schema);
formSchema.addProperties(name, schema);
}

List<String> mediaTypes = new ArrayList<>(globalConsumes);
Expand All @@ -709,6 +676,69 @@ private RequestBody convertFormDataToRequestBody(List<io.swagger.models.paramete
return body;
}

private Schema convert(SerializableParameter sp) {
Schema schema;
if ("file".equals(sp.getType())) {
schema = new FileSchema();
} else if ("array".equals(sp.getType())) {
ArraySchema as = new ArraySchema();
if (sp.getItems() != null) {
as.setItems(convert(sp.getItems()));
}
schema = as;
} else {
schema = new Schema();
schema.setType(sp.getType());
schema.setFormat(sp.getFormat());
}

schema.setDescription(sp.getDescription());
schema.setReadOnly(sp.isReadOnly());
schema.setEnum(sp.getEnum());

if (sp.getMaxItems() != null) {
schema.setMaxItems(sp.getMaxItems());
}
if (sp.getMinItems() != null) {
schema.setMinItems(sp.getMinItems());
}
if (sp.isUniqueItems() != null) {
schema.setUniqueItems(sp.isUniqueItems());
}

schema.setMaximum(sp.getMaximum());
schema.setExclusiveMaximum(sp.isExclusiveMaximum());
schema.setMinimum(sp.getMinimum());
schema.setExclusiveMinimum(sp.isExclusiveMinimum());
schema.setMinLength(sp.getMinLength());
schema.setMaxLength(sp.getMaxLength());
schema.setName(sp.getName());

if (sp.getVendorExtensions() != null) {
Object exampleExtension = sp.getVendorExtensions().get("x-example");
if (exampleExtension != null) {
schema.setExample(exampleExtension);
}
Object nullableExtension = sp.getVendorExtensions().get("x-nullable");
if (nullableExtension != null) {
schema.setNullable((Boolean) nullableExtension);
}
schema.setExtensions(convert(sp.getVendorExtensions()));
}

if (sp.getMultipleOf() != null) {
schema.setMultipleOf(new BigDecimal(sp.getMultipleOf().toString()));
}

schema.setPattern(sp.getPattern());

if (sp instanceof AbstractSerializableParameter) {
AbstractSerializableParameter ap = (AbstractSerializableParameter) sp;
schema.setDefault(ap.getDefault());
}
return schema;
}

private RequestBody convertParameterToRequestBody(io.swagger.models.parameters.Parameter param) {
return convertParameterToRequestBody(param, null);
}
Expand Down Expand Up @@ -957,6 +987,8 @@ public Parameter convert(io.swagger.models.parameters.Parameter v2Parameter) {
if (components.getRequestBodies() != null &&
components.getRequestBodies().get(ref.getSimpleRef()) != null) {
updatedRef += "requestBodies";
} else if (components.getSchemas() != null && components.getSchemas().get("formData_" + ref.getSimpleRef()) != null) {
updatedRef += "schemas";
} else {
updatedRef += "parameters";
}
Expand Down
9 changes: 5 additions & 4 deletions ...les/swagger-parser-v2-converter/src/test/java/io/swagger/parser/test/V2ConverterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,11 +325,12 @@ public void testIssue16() throws Exception {
public void testIssue17() throws Exception {
OpenAPI oas = getConvertedOpenAPIFromJsonFile(ISSUE_17_JSON);
Map<String, RequestBody> requestBodies = oas.getComponents().getRequestBodies();
assertNotNull(requestBodies.get("formEmail").getContent().get("multipart/form-data"));
assertNotNull(requestBodies.get("formPassword").getContent().get("multipart/form-data"));
Map<String, Schema> schemas = oas.getComponents().getSchemas();
assertNotNull(schemas.get("formData_formEmail"));
assertNotNull(schemas.get("formData_formPassword"));
assertNotNull(requestBodies.get("bodyParam").getContent().get("*/*"));
assertEquals(oas.getPaths().get("/formPost").getPost().getParameters().get(0).get$ref(),
REQUEST_BODY_FORMEMAIL);
assertNull(oas.getPaths().get("/formPost").getPost().getParameters());
assertNotNull(oas.getPaths().get("/formPost").getPost().getRequestBody());
assertNotNull(oas.getPaths().get("/report/{userId}").getGet().getRequestBody().
getContent().get("multipart/form-data").getSchema().getProperties().get("limitForm"));
}
Expand Down