Skip to content

Supporting change in additionalProperties Boolean and Schema #612

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 11 commits into from
Jan 15, 2018
Merged

Supporting change in additionalProperties Boolean and Schema #612

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
0007abe
refs #499 - casting additionalProperties to Schema
gracekarina Dec 22, 2017
2b5948d
changes in parser to support additional properties as boolean and Sch…
gracekarina Dec 26, 2017
fa10ceb
support to additionalProperties Boolean and Schema
gracekarina Dec 28, 2017
09d4809
support to additionalProperties Boolean and Schema #499
gracekarina Dec 28, 2017
5069f03
fixing PR comments refs #499 swagger-api/swagger-core#2461
gracekarina Dec 29, 2017
7c3c740
adding test to additionalProperties - refactoring deserialization - r…
gracekarina Dec 30, 2017
d4083ce
changing Json version to v3 git - refs# 499 - swagger-api/swagger-cor…
gracekarina Jan 10, 2018
0c0a835
Merge branch '2.0' into ticket-2461_2.0
gracekarina Jan 10, 2018
364ab1b
additionalProperty as Schema
gracekarina Jan 10, 2018
8ad092d
solving conflicts
gracekarina Jan 12, 2018
0e0d44e
trigger travis
frantuma Jan 15, 2018
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
5 changes: 5 additions & 0 deletions modules/swagger-parser-v2-converter/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,11 @@
<artifactId>swagger-parser-core</artifactId>
<version>${parent.version}</version>
</dependency>
<dependency>
<groupId>io.swagger.parser.v3</groupId>
<artifactId>swagger-parser-v3</artifactId>
<version>${parent.version}</version>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
Expand Down
11 changes: 9 additions & 2 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 @@ -22,14 +22,15 @@
import io.swagger.models.parameters.SerializableParameter;
import io.swagger.models.properties.AbstractNumericProperty;
import io.swagger.models.properties.ArrayProperty;
import io.swagger.models.properties.FileProperty;
import io.swagger.models.properties.MapProperty;
import io.swagger.models.properties.ObjectProperty;
import io.swagger.models.properties.Property;
import io.swagger.models.properties.RefProperty;
import io.swagger.parser.SwaggerParser;
import io.swagger.parser.SwaggerResolver;
import io.swagger.parser.util.SwaggerDeserializationResult;
import io.swagger.util.Json;
import io.swagger.v3.core.util.Json;
import io.swagger.v3.oas.models.Components;
import io.swagger.v3.oas.models.ExternalDocumentation;
import io.swagger.v3.oas.models.OpenAPI;
Expand Down Expand Up @@ -63,6 +64,7 @@
import io.swagger.v3.parser.core.models.SwaggerParseResult;
import org.apache.commons.lang3.StringUtils;


import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.Arrays;
Expand Down Expand Up @@ -837,7 +839,11 @@ private Schema convert(Property schema) {

result = arraySchema;

} else {
} else if (schema instanceof FileProperty) {
FileSchema fileSchema = Json.mapper().convertValue(schema, FileSchema.class);
result = fileSchema;

}else {

result = Json.mapper().convertValue(schema, Schema.class);
result.setExample(schema.getExample());
Expand Down Expand Up @@ -1071,3 +1077,4 @@ public Schema convert(io.swagger.models.Model v2Model) {
return result;
}
}

11 changes: 6 additions & 5 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 @@ -144,8 +144,8 @@ public class V2ConverterTest {
private static final int NUMBER_VALUE_TWENTY = 20;
private static final double MULTIPLE_OF_VALUE = 0.01D;
private static final long DEFAULT_VALUE = 11L;
private static final long EXAMPLE_8_NUMBER = 8L;
private static final long EXAMPLE_42_NUMBER = 42L;
private static final int EXAMPLE_8_NUMBER = 8;
private static final int EXAMPLE_42_NUMBER = 42;

@Test
public void testConvertPetstore() throws Exception {
Expand Down Expand Up @@ -372,11 +372,12 @@ public void testIssue22() throws Exception {
assertNotNull(oas);
}

@Test(description = "$ref not updated in components (aditional properties)")
@Test(description = "$ref not updated in components (additional properties)")
public void testIssue23() throws Exception {
OpenAPI oas = getConvertedOpenAPIFromJsonFile(ISSUE_23_JSON);
assertEquals(OBJECT_REF, oas.getComponents().getSchemas()
.get(MAP_OBJECTS_MODEL).getAdditionalProperties().get$ref());
assertTrue(oas.getComponents().getSchemas().get(MAP_OBJECTS_MODEL).getAdditionalProperties() instanceof Schema);
Schema additionalProperties = (Schema) oas.getComponents().getSchemas().get(MAP_OBJECTS_MODEL).getAdditionalProperties();
assertEquals(OBJECT_REF,additionalProperties.get$ref());
}

@Test(description = "Covert path item $refs")
Expand Down
34 changes: 17 additions & 17 deletions ...swagger-parser-v3/src/main/java/io/swagger/v3/parser/processors/ExternalRefProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,21 +102,21 @@ public String processRefToExternalSchema(String $ref, RefFormat refFormat) {
StringUtils.isNotBlank(arrayProp.get$ref())) {
processRefProperty(arrayProp.getItems(), file);
}
} else if (prop.getValue().getAdditionalProperties() != null) {
Schema mapProp = prop.getValue();
if (mapProp.getAdditionalProperties().get$ref() != null) {
processRefProperty(mapProp.getAdditionalProperties(), file);
} else if (prop.getValue().getAdditionalProperties() != null && prop.getValue().getAdditionalProperties() instanceof Schema) {
Schema mapProp = (Schema) prop.getValue().getAdditionalProperties();
if (mapProp.get$ref() != null) {
processRefProperty(mapProp, file);
} else if (mapProp.getAdditionalProperties() instanceof ArraySchema &&
((ArraySchema) mapProp.getAdditionalProperties()).getItems()!= null &&
((ArraySchema) mapProp.getAdditionalProperties()).getItems().get$ref() != null
&& StringUtils.isNotBlank(((ArraySchema) mapProp.getAdditionalProperties()).getItems().get$ref())) {
((ArraySchema) mapProp).getItems()!= null &&
((ArraySchema) mapProp).getItems().get$ref() != null
&& StringUtils.isNotBlank(((ArraySchema) mapProp).getItems().get$ref())) {
processRefProperty(((ArraySchema) mapProp.getAdditionalProperties()).getItems(), file);
}
}
}
}
if(schema.getAdditionalProperties() != null){
Schema additionalProperty = schema.getAdditionalProperties();
if(schema.getAdditionalProperties() != null && schema.getAdditionalProperties() instanceof Schema){
Schema additionalProperty = (Schema) schema.getAdditionalProperties();
if (additionalProperty.get$ref() != null) {
processRefProperty(additionalProperty, file);
} else if (additionalProperty instanceof ArraySchema) {
Expand All @@ -125,15 +125,15 @@ public String processRefToExternalSchema(String $ref, RefFormat refFormat) {
StringUtils.isNotBlank(arrayProp.get$ref())) {
processRefProperty(arrayProp.getItems(), file);
}
} else if (additionalProperty.getAdditionalProperties() != null) {
Schema mapProp = additionalProperty;
if (mapProp.getAdditionalProperties().get$ref() != null) {
processRefProperty(mapProp.getAdditionalProperties(), file);
} else if (additionalProperty.getAdditionalProperties() != null && additionalProperty.getAdditionalProperties() instanceof Schema) {
Schema mapProp = (Schema) additionalProperty.getAdditionalProperties();
if (mapProp.get$ref() != null) {
processRefProperty(mapProp, file);
} else if (mapProp.getAdditionalProperties() instanceof ArraySchema &&
((ArraySchema) mapProp.getAdditionalProperties()).getItems() != null &&
((ArraySchema) mapProp.getAdditionalProperties()).getItems().get$ref() != null
&& StringUtils.isNotBlank(((ArraySchema) mapProp.getAdditionalProperties()).getItems().get$ref())) {
processRefProperty(((ArraySchema) mapProp.getAdditionalProperties()).getItems(), file);
((ArraySchema) mapProp).getItems() != null &&
((ArraySchema) mapProp).getItems().get$ref() != null
&& StringUtils.isNotBlank(((ArraySchema) mapProp).getItems().get$ref())) {
processRefProperty(((ArraySchema) mapProp).getItems(), file);
}
}

Expand Down
18 changes: 11 additions & 7 deletions modules/swagger-parser-v3/src/main/java/io/swagger/v3/parser/processors/SchemaProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,17 @@ public void processSchemaType(Schema schema){

}

private void processAdditionalProperties(Schema schema) {

if (schema.getAdditionalProperties() != null){
if(schema.getAdditionalProperties().get$ref() != null){
processReferenceSchema(schema.getAdditionalProperties());
}else{
processSchemaType(schema.getAdditionalProperties());
private void processAdditionalProperties(Object additionalProperties) {

if (additionalProperties instanceof Schema) {
Schema schema = (Schema) additionalProperties;
if (schema.getAdditionalProperties() != null && schema.getAdditionalProperties() instanceof Schema) {
Schema additionalPropertiesSchema = (Schema) schema.getAdditionalProperties();
if (additionalPropertiesSchema.get$ref() != null) {
processReferenceSchema(additionalPropertiesSchema);
} else {
processSchemaType(additionalPropertiesSchema);
}
}
}
}
Expand Down
14 changes: 8 additions & 6 deletions modules/swagger-parser-v3/src/main/java/io/swagger/v3/parser/util/InlineModelResolver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,9 +180,9 @@ public void flatten(OpenAPI openAPI) {
}
}
}
} else if (property.getAdditionalProperties() != null) {
} else if (property.getAdditionalProperties() != null && property.getAdditionalProperties() instanceof Schema) {

Schema innerProperty = property.getAdditionalProperties();
Schema innerProperty = (Schema) property.getAdditionalProperties();
if (innerProperty instanceof ObjectSchema) {
ObjectSchema op = (ObjectSchema) innerProperty;
if (op.getProperties() != null && op.getProperties().size() > 0) {
Expand Down Expand Up @@ -365,8 +365,8 @@ public void flattenProperties(Map<String, Schema> properties, String path) {
}
}
}
} else if (property.getAdditionalProperties() != null) {
Schema inner = property.getAdditionalProperties();
} else if (property.getAdditionalProperties() != null && property.getAdditionalProperties() instanceof Schema) {
Schema inner = (Schema) property.getAdditionalProperties();

if (inner instanceof ObjectSchema) {
ObjectSchema op = (ObjectSchema) inner;
Expand Down Expand Up @@ -454,11 +454,13 @@ public Schema modelFromProperty(Schema object, @SuppressWarnings("unused") Strin
if (obj != null) {
example = obj.toString();
}

ArraySchema model = new ArraySchema();
model.setDescription(description);
model.setExample(example);
model.setItems(object.getAdditionalProperties());
if (object.getAdditionalProperties() != null && object.getAdditionalProperties() instanceof Schema) {
model.setItems((Schema) object.getAdditionalProperties());
}


return model;
}
Expand Down
21 changes: 16 additions & 5 deletions modules/swagger-parser-v3/src/main/java/io/swagger/v3/parser/util/OpenAPIDeserializer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1983,11 +1983,22 @@ public Schema getSchema(ObjectNode node, String location, ParseResult result){
schema.setProperties(properties);
}

ObjectNode additionalPropertiesObj = getObject("additionalProperties", node, false, location, result);
if(additionalPropertiesObj != null) {
Schema additionalProperties = getSchema(additionalPropertiesObj, location, result);
if(additionalProperties != null) {
schema.setAdditionalProperties(additionalProperties);

if (node.get("additionalProperties") != null) {
if (node.get("additionalProperties").getNodeType().equals(JsonNodeType.OBJECT)) {
ObjectNode additionalPropertiesObj = getObject("additionalProperties", node, false, location, result);
if (additionalPropertiesObj != null) {
Schema additionalProperties = getSchema(additionalPropertiesObj, location, result);
if (additionalProperties != null) {
schema.setAdditionalProperties(additionalProperties);
}
}
} else if (node.get("additionalProperties").getNodeType().equals(JsonNodeType.BOOLEAN)) {
Boolean additionalProperties = getBoolean("additionalProperties", node, false, location, result);
if (additionalProperties != null) {
schema.setAdditionalProperties(additionalProperties);
}

}
}
value = getString("description",node,false,location,result);
Expand Down
4 changes: 3 additions & 1 deletion modules/swagger-parser-v3/src/test/java/io/swagger/v3/parser/test/OpenAPIResolverTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,9 @@ public void componentsResolver(@Injectable final List<AuthorizationValue> auths)
assertEquals(schemas.get("OrderRef").getNot().get$ref(), "#/components/schemas/Category");

//Schema additionalProperties
assertEquals(schemas.get("OrderRef").getAdditionalProperties().get$ref(), "#/components/schemas/User_3");
assertTrue(schemas.get("OrderRef").getAdditionalProperties() instanceof Schema);
Schema additionalProperties = (Schema) schemas.get("OrderRef").getAdditionalProperties();
assertEquals(additionalProperties.get$ref(), "#/components/schemas/User_3");

//AllOfSchema
ComposedSchema extended = (ComposedSchema) schemas.get("ExtendedErrorModel");
Expand Down
24 changes: 13 additions & 11 deletions modules/swagger-parser-v3/src/test/java/io/swagger/v3/parser/test/OpenAPIV3ParserTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,14 @@
import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.Random;
import java.util.stream.Collectors;

import static com.github.tomakehurst.wiremock.client.WireMock.aResponse;
import static com.github.tomakehurst.wiremock.client.WireMock.get;
import static com.github.tomakehurst.wiremock.client.WireMock.urlPathMatching;
import static org.testng.AssertJUnit.assertNotNull;
import static org.testng.AssertJUnit.assertTrue;
import static org.testng.Assert.assertEquals;
import static org.testng.Assert.assertNotNull;
import static org.testng.Assert.assertTrue;


public class OpenAPIV3ParserTest {
Expand Down Expand Up @@ -169,8 +171,8 @@ public void test30(@Injectable final List<AuthorizationValue> auths) throws Exce

Assert.assertNotNull(result);
Assert.assertNotNull(result.getOpenAPI());
Assert.assertEquals(result.getOpenAPI().getOpenapi(), "3.0.1");
Assert.assertEquals(result.getOpenAPI().getComponents().getSchemas().get("OrderRef").getType(),"object");
assertEquals(result.getOpenAPI().getOpenapi(), "3.0.1");
assertEquals(result.getOpenAPI().getComponents().getSchemas().get("OrderRef").getType(),"object");
}

@Test
Expand All @@ -187,8 +189,8 @@ public void testResolveFully(@Injectable final List<AuthorizationValue> auths) t

Assert.assertNotNull(result);
Assert.assertNotNull(result.getOpenAPI());
Assert.assertEquals(result.getOpenAPI().getOpenapi(), "3.0.1");
Assert.assertEquals(result.getOpenAPI().getComponents().getSchemas().get("OrderRef").getType(),"object");
assertEquals(result.getOpenAPI().getOpenapi(), "3.0.1");
assertEquals(result.getOpenAPI().getComponents().getSchemas().get("OrderRef").getType(),"object");
}

@Test
Expand Down Expand Up @@ -219,8 +221,8 @@ public void testResolveFullyExample(@Injectable final List<AuthorizationValue> a
Assert.assertNotNull(result.getOpenAPI());
Components components = result.getOpenAPI().getComponents();
ApiResponse response = result.getOpenAPI().getPaths().get("/mockResponses/objectMultipleExamples").getGet().getResponses().get("200");
Assert.assertEquals(response.getContent().get("application/json").getExamples().get("ArthurDent"), components.getExamples().get("Arthur"));
Assert.assertEquals(response.getContent().get("application/xml").getExamples().get("Trillian"), components.getExamples().get("Trillian"));
assertEquals(response.getContent().get("application/json").getExamples().get("ArthurDent"), components.getExamples().get("Arthur"));
assertEquals(response.getContent().get("application/xml").getExamples().get("Trillian"), components.getExamples().get("Trillian"));
}

@Test
Expand Down Expand Up @@ -262,8 +264,8 @@ public void test30NoOptions(@Injectable final List<AuthorizationValue> auths) th

Assert.assertNotNull(result);
Assert.assertNotNull(result.getOpenAPI());
Assert.assertEquals(result.getOpenAPI().getOpenapi(), "3.0.1");
Assert.assertEquals(result.getOpenAPI().getComponents().getSchemas().get("OrderRef").getType(),"object");
assertEquals(result.getOpenAPI().getOpenapi(), "3.0.1");
assertEquals(result.getOpenAPI().getComponents().getSchemas().get("OrderRef").getType(),"object");
}

@Test
Expand All @@ -274,7 +276,7 @@ public void testShellMethod(@Injectable final List<AuthorizationValue> auths){

OpenAPI openAPI = new OpenAPIV3Parser().read(url);
Assert.assertNotNull(openAPI);
Assert.assertEquals(openAPI.getOpenapi(), "3.0.1");
assertEquals(openAPI.getOpenapi(), "3.0.1");
}

@Test
Expand Down
3 changes: 2 additions & 1 deletion ...es/swagger-parser-v3/src/test/java/io/swagger/v3/parser/util/InlineModelResolverTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1107,8 +1107,9 @@ public void testArbitraryObjectResponseMapInline() {

Schema property = response.getContent().get("*/*").getSchema();
assertTrue(property.getAdditionalProperties() != null);
assertTrue(property.getAdditionalProperties() instanceof Schema);
assertTrue(openAPI.getComponents().getSchemas() == null);
Schema inlineProp = property.getAdditionalProperties();
Schema inlineProp = (Schema)property.getAdditionalProperties();
assertTrue(inlineProp instanceof ObjectSchema);
ObjectSchema op = (ObjectSchema) inlineProp;
assertNull(op.getProperties());
Expand Down
4 changes: 3 additions & 1 deletion ...es/swagger-parser-v3/src/test/java/io/swagger/v3/parser/util/OpenAPIDeserializerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1164,7 +1164,9 @@ public void readComponentsObject(JsonNode rootNode) throws Exception {
Assert.assertEquals(component.getSchemas().get("ApiResponse").getRequired().get(0),"name");
Assert.assertEquals(component.getSchemas().get("Order").getType(),"object");
Assert.assertEquals(component.getSchemas().get("Order").getNot().getType(),"integer");
Assert.assertEquals(component.getSchemas().get("Order").getAdditionalProperties().getType(),"integer");
assertTrue(component.getSchemas().get("Order").getAdditionalProperties() instanceof Schema);
Schema additionalProperties = (Schema) component.getSchemas().get("Order").getAdditionalProperties();
Assert.assertEquals(additionalProperties.getType(),"integer");

Schema schema = (Schema) component.getSchemas().get("Order").getProperties().get("status");

Expand Down
Loading