Skip to content

Validate empty Swagger property names #2343

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

Open
king-407 wants to merge 1 commit into
base: master
Choose a base branch
from
+169 −1
Open

Validate empty Swagger property names #2343

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
131 changes: 130 additions & 1 deletion ...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 @@ -153,6 +153,7 @@ public SwaggerParseResult convert(SwaggerDeserializationResult parse) {
SwaggerInventory inventory = new SwaggerInventory().process(parse.getSwagger());

Swagger swagger = parse.getSwagger();
addEmptyPropertyNameMessages(swagger, output);

if (swagger.getVendorExtensions() != null) {
openAPI.setExtensions(convert(swagger.getVendorExtensions()));
Expand Down Expand Up @@ -665,6 +666,135 @@ private Map<String, Object> convert(Map<String, Object> vendorExtensions) {
return result;
}

private void addEmptyPropertyNameMessages(Swagger swagger, SwaggerParseResult output) {
if (swagger.getDefinitions() != null) {
swagger.getDefinitions().forEach((name, model) ->
addEmptyPropertyNameMessages("definitions." + name, model, output));
}

if (swagger.getPaths() != null) {
swagger.getPaths().forEach((pathname, path) -> {
if (path == null) {
return;
}
addEmptyPropertyNameMessages("paths.'" + pathname + "'.parameters", path.getParameters(), output);
addEmptyPropertyNameMessages("paths.'" + pathname + "'(get)", path.getGet(), output);
addEmptyPropertyNameMessages("paths.'" + pathname + "'(put)", path.getPut(), output);
addEmptyPropertyNameMessages("paths.'" + pathname + "'(post)", path.getPost(), output);
addEmptyPropertyNameMessages("paths.'" + pathname + "'(delete)", path.getDelete(), output);
addEmptyPropertyNameMessages("paths.'" + pathname + "'(options)", path.getOptions(), output);
addEmptyPropertyNameMessages("paths.'" + pathname + "'(head)", path.getHead(), output);
addEmptyPropertyNameMessages("paths.'" + pathname + "'(patch)", path.getPatch(), output);
});
}
}

private void addEmptyPropertyNameMessages(String location, io.swagger.models.Operation operation,
SwaggerParseResult output) {
if (operation == null) {
return;
}
addEmptyPropertyNameMessages(location + ".parameters", operation.getParameters(), output);

if (operation.getResponses() != null) {
operation.getResponses().forEach((code, response) -> {
if (response != null) {
addEmptyPropertyNameMessages(location + ".responses." + code + ".schema",
response.getResponseSchema(), output);
}
});
}
}

private void addEmptyPropertyNameMessages(String location, List<io.swagger.models.parameters.Parameter> parameters,
SwaggerParseResult output) {
if (parameters == null) {
return;
}

parameters.forEach(parameter -> {
if (parameter == null) {
return;
}
if (parameter instanceof BodyParameter) {
BodyParameter bodyParameter = (BodyParameter) parameter;
addEmptyPropertyNameMessages(location + ".[" + bodyParameter.getName() + "].schema",
bodyParameter.getSchema(), output);
}
});
}

private void addEmptyPropertyNameMessages(String location, Model model, SwaggerParseResult output) {
if (model == null) {
return;
}

if (model instanceof ArrayModel) {
addEmptyPropertyNameMessages(location + ".items", ((ArrayModel) model).getItems(), output);
} else if (model instanceof ComposedModel) {
ComposedModel composedModel = (ComposedModel) model;
if (composedModel.getAllOf() != null) {
for (int i = 0; i < composedModel.getAllOf().size(); i++) {
addEmptyPropertyNameMessages(location + ".allOf." + i, composedModel.getAllOf().get(i), output);
}
}
}

addEmptyPropertyNameMessages(location + ".properties", model.getProperties(), output);

if (model instanceof ModelImpl) {
addEmptyPropertyNameMessages(location + ".additionalProperties",
((ModelImpl) model).getAdditionalProperties(), output);
}
}

private void addEmptyPropertyNameMessages(String location, Property property, SwaggerParseResult output) {
if (property == null) {
return;
}

if (property instanceof ArrayProperty) {
addEmptyPropertyNameMessages(location + ".items", ((ArrayProperty) property).getItems(), output);
} else if (property instanceof ObjectProperty) {
addEmptyPropertyNameMessages(location + ".properties", ((ObjectProperty) property).getProperties(), output);
} else if (property instanceof MapProperty) {
addEmptyPropertyNameMessages(location + ".additionalProperties",
((MapProperty) property).getAdditionalProperties(), output);
} else if (property instanceof ComposedProperty) {
ComposedProperty composedProperty = (ComposedProperty) property;
if (composedProperty.getAllOf() != null) {
for (int i = 0; i < composedProperty.getAllOf().size(); i++) {
addEmptyPropertyNameMessages(location + ".allOf." + i, composedProperty.getAllOf().get(i), output);
}
}
}
}

private void addEmptyPropertyNameMessages(String location, Map<String, Property> properties,
SwaggerParseResult output) {
if (properties == null) {
return;
}

properties.forEach((name, property) -> {
if (StringUtils.isEmpty(name)) {
addMessage(output, "attribute " + location + " contains an empty property name");
}
addEmptyPropertyNameMessages(location + "." + name, property, output);
});
}

private void addMessage(SwaggerParseResult output, String message) {
List<String> messages = output.getMessages();
if (messages == null) {
messages = new ArrayList<>();
output.messages(messages);
}
if (!messages.contains(message)) {
messages.add(message);
}
}

private Schema convertFormDataToSchema(io.swagger.models.parameters.Parameter formParam) {
SerializableParameter sp = (SerializableParameter) formParam;
return convert(sp);
Expand Down Expand Up @@ -1276,4 +1406,3 @@ private void addProperties(Model v2Model, Schema schema) {
}
}
}

39 changes: 39 additions & 0 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 @@ -737,6 +737,45 @@ public void testSwaggerParseResultHasMessage() throws Exception {
assertNotNull(result.getMessages());
}

@Test(description = "OpenAPI v2 converter - empty property names report validation messages")
public void testEmptyPropertyNameHasMessage() {
String swaggerAsString = "{\n" +
" \"swagger\": \"2.0\",\n" +
" \"info\": {\n" +
" \"title\": \"info_title\",\n" +
" \"version\": \"0/0\"\n" +
" },\n" +
" \"paths\": {\n" +
" \"/path\": {\n" +
" \"get\": {\n" +
" \"responses\": {\n" +
" \"200\": {\n" +
" \"description\": \"..\",\n" +
" \"schema\": {\n" +
" \"type\": \"object\",\n" +
" \"properties\": {\n" +
" \"AA\": {\n" +
" \"type\": \"string\"\n" +
" },\n" +
" \"\": {\n" +
" \"type\": \"number\"\n" +
" }\n" +
" }\n" +
" }\n" +
" }\n" +
" }\n" +
" }\n" +
" }\n" +
" }\n" +
"}";

SwaggerParseResult result = new SwaggerConverter().readContents(swaggerAsString, null, null);

assertNotNull(result.getMessages());
assertTrue(result.getMessages().contains(
"attribute paths.'/path'(get).responses.200.schema.properties contains an empty property name"));
}


@Test(description = "OpenAPI v2 converter - Migrate minLength, maxLength and pattern of String property")
public void testIssue786() throws Exception {
Expand Down