Skip to content

[issue #1047] Ensure error message when "items" undefined for schema with type=array #1101

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
May 28, 2019
Merged

[issue #1047] Ensure error message when "items" undefined for schema with type=array #1101

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
3 changes: 3 additions & 0 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 @@ -2262,6 +2262,9 @@ public Schema getSchema(ObjectNode node, String location, ParseResult result){
schema.setType(type);
}
}
if("array".equals( schema.getType()) && !(schema instanceof ArraySchema && ((ArraySchema) schema).getItems() != null)) {
result.missing(location, "items");
}
}

ObjectNode notObj = getObject("not", node, false, location, result);
Expand Down
41 changes: 41 additions & 0 deletions ...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 @@ -763,6 +763,47 @@ public void testArrayQueryParam() throws Exception {
assertTrue(((ArraySchema) p).getItems() instanceof StringSchema);
}

@Test
public void testArrayItems() {
String yaml =
"openapi: 3.0.0\n" +
"info:\n" +
" title: Test\n" +
" version: 1.0.0\n" +
"paths:\n" +
" \"/store/inventory\":\n" +
" post:\n" +
" requestBody:\n" +
" content:\n" +
" application/json:\n" +
" schema:\n" +
" type: array\n" +
" minItems: 1\n" +
" responses:\n" +
" '200':\n" +
" description: successful operation\n" +
" content:\n" +
" application/json:\n" +
" schema:\n" +
" items:\n" +
" type: string"
;

OpenAPIV3Parser parser = new OpenAPIV3Parser();
SwaggerParseResult result = parser.readContents(yaml, null, null);
assertEquals(result.getMessages(), Arrays.asList("attribute paths.'/store/inventory'(post).requestBody.content.schema.items is missing"));

OpenAPI openAPI = result.getOpenAPI();

Schema body = openAPI.getPaths().get("/store/inventory").getPost().getRequestBody().getContent().get("application/json").getSchema();
assertFalse(body.getClass().equals( ArraySchema.class), "body is an ArraySchema");
assertEquals(body.getType(), "array");
assertEquals(body.getMinItems(), Integer.valueOf(1));

Schema response = openAPI.getPaths().get("/store/inventory").getPost().getResponses().get("200").getContent().get("application/json").getSchema();
assertTrue(response.getClass().equals( ArraySchema.class), "response is an ArraySchema");
assertEquals(body.getType(), "array");
}

@Test(description = "it should read a top-level extension per https://github.com/openAPI-api/validator-badge/issues/59")
public void testToplevelExtension() throws Exception {
Expand Down