Skip to content

getMediaType: Report an error for any encoding property not defined in the schema. #1712

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 5 commits into from
Jun 22, 2022
Merged

getMediaType: Report an error for any encoding property not defined in the schema. #1712

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b35c8c2
getMediaType: Report an error for any encoding property not defined i…
kerrykimbrough Apr 21, 2022
38ba0e6
Merge branch 'master' into issue-1711
kerrykimbrough Jun 15, 2022
ca6bd63
Merge branch 'master' into issue-1711
kerrykimbrough Jun 15, 2022
c8b9e8e
getMediaType: Handle correctly when schema is undefined or defined by…
kerrykimbrough Jun 16, 2022
0d8fae7
Merge branch 'master' into issue-1711
kerrykimbrough Jun 17, 2022
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
23 changes: 20 additions & 3 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 @@ -72,6 +72,7 @@
import java.util.regex.Pattern;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import static java.util.Collections.emptySet;


public class OpenAPIDeserializer {
Expand Down Expand Up @@ -1354,11 +1355,27 @@ public MediaType getMediaType(ObjectNode contentNode, String location, ParseResu
mediaType.setSchema(getSchema(schemaObject, String.format("%s.%s", location, "schema"), result));
}


ObjectNode encodingObject = getObject("encoding", contentNode, false, location, result);
if (encodingObject != null) {
mediaType.setEncoding(getEncodingMap(encodingObject, String.format("%s.%s", location, "encoding"),
result));
String encodingLocation = String.format("%s.%s", location, "encoding");
mediaType.setEncoding(getEncodingMap(encodingObject, encodingLocation, result));

// Given all properties defined for this media type object...
Set<String> mediaTypeProperties =
mediaType.getSchema() == null?
emptySet() :

mediaType.getSchema().get$ref() == null?
Optional.ofNullable( mediaType.getSchema().getProperties()).map( Map::keySet).orElse( emptySet()) :

null;

if( mediaTypeProperties != null) {
// ... report an error if an encoding is specified for an undefined property
mediaType.getEncoding().keySet().stream()
.filter( ep -> !mediaTypeProperties.contains( ep))
.forEach( ep -> result.extra( encodingLocation, ep, encodingObject));
}
}
Map<String, Object> extensions = getExtensions(contentNode);
if (extensions != null && extensions.size() > 0) {
Expand Down
153 changes: 153 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 @@ -1277,6 +1277,159 @@ public void testBodyContent() {
assertEquals( result.getMessages().size(), 2, "Messages");
}

@Test
public void testEncodingNotApplicable() {
String json =
"{"
+ " \"openapi\": \"3.0.0\","
+ " \"info\": {"
+ " \"title\": \"Encodings\","
+ " \"version\": \"0.0.0\""
+ " },"
+ " \"paths\": {"
+ " \"/properties\": {"
+ " \"post\": {"
+ " \"requestBody\": {"
+ " \"content\": {"
+ " \"multipart/form-data\": {"
+ " \"schema\": {"
+ " \"type\": \"object\","
+ " \"properties\": {"
+ " \"X\": {"
+ " \"type\": \"integer\""
+ " },"
+ " \"Y\": {"
+ " \"type\": \"integer\""
+ " }"
+ " }"
+ " },"
+ " \"encoding\": {"
+ " \"X\": {"
+ " \"contentType\": \"application/json\""
+ " },"
+ " \"Z\": {"
+ " \"contentType\": \"text/plain\""
+ " }"
+ " }"
+ " }"
+ " }"
+ " },"
+ " \"responses\": {"
+ " \"default\": {"
+ " \"description\": \"None\""
+ " }"
+ " }"
+ " }"
+ " },"
+ " \"/propertiesNone\": {"
+ " \"post\": {"
+ " \"requestBody\": {"
+ " \"content\": {"
+ " \"multipart/form-data\": {"
+ " \"schema\": {"
+ " \"type\": \"object\""
+ " },"
+ " \"encoding\": {"
+ " \"X\": {"
+ " \"contentType\": \"application/json\""
+ " },"
+ " \"Z\": {"
+ " \"contentType\": \"text/plain\""
+ " }"
+ " }"
+ " }"
+ " }"
+ " },"
+ " \"responses\": {"
+ " \"default\": {"
+ " \"description\": \"None\""
+ " }"
+ " }"
+ " }"
+ " },"
+ " \"/schemaNone\": {"
+ " \"post\": {"
+ " \"requestBody\": {"
+ " \"content\": {"
+ " \"application/x-www-form-urlencoded\": {"
+ " \"encoding\": {"
+ " \"X\": {"
+ " \"contentType\": \"application/json\""
+ " },"
+ " \"Z\": {"
+ " \"contentType\": \"text/plain\""
+ " }"
+ " }"
+ " }"
+ " }"
+ " },"
+ " \"responses\": {"
+ " \"default\": {"
+ " \"description\": \"None\""
+ " }"
+ " }"
+ " }"
+ " },"
+ " \"/schemaRef\": {"
+ " \"post\": {"
+ " \"requestBody\": {"
+ " \"content\": {"
+ " \"application/x-www-form-urlencoded\": {"
+ " \"schema\": {"
+ " \"$ref\": \"#/components/schemas/encoded\""
+ " },"
+ " \"encoding\": {"
+ " \"X\": {"
+ " \"contentType\": \"application/json\""
+ " },"
+ " \"Z\": {"
+ " \"contentType\": \"text/plain\""
+ " }"
+ " }"
+ " }"
+ " }"
+ " },"
+ " \"responses\": {"
+ " \"default\": {"
+ " \"description\": \"None\""
+ " }"
+ " }"
+ " }"
+ " }"
+ " },"
+ " \"components\": {"
+ " \"schemas\": {"
+ " \"encoded\": {"
+ " \"type\": \"object\","
+ " \"properties\": {"
+ " \"X\": {"
+ " \"type\": \"integer\""
+ " },"
+ " \"Y\": {"
+ " \"type\": \"integer\""
+ " }"
+ " }"
+ " }"
+ " }"
+ " }"
+ "}"
;
OpenAPIV3Parser parser = new OpenAPIV3Parser();
SwaggerParseResult result = parser.readContents(json, null, null);

assertEquals
( result.getMessages(),

Arrays.asList
( "attribute paths.'/properties'(post).requestBody.content.'multipart/form-data'.encoding.Z is unexpected",
"attribute paths.'/propertiesNone'(post).requestBody.content.'multipart/form-data'.encoding.X is unexpected",
"attribute paths.'/propertiesNone'(post).requestBody.content.'multipart/form-data'.encoding.Z is unexpected",
"attribute paths.'/schemaNone'(post).requestBody.content.'application/x-www-form-urlencoded'.encoding.X is unexpected",
"attribute paths.'/schemaNone'(post).requestBody.content.'application/x-www-form-urlencoded'.encoding.Z is unexpected"),

"Error messages");
}

@Test
public void testStyleInvalid() {
String json =
Expand Down