Skip to content

Fixed override issue on property collectionFormat part of annotation @ApiImplicitParam #2800

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 2 commits into from
May 8, 2018
Merged

Fixed override issue on property collectionFormat part of annotation @ApiImplicitParam #2800

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
30d168d
Fixed override issue on property collectionFormat part of annotation …
Jun 27, 2017
26831db
collectionFormat override fix - rebase and imports
frantuma May 8, 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
11 changes: 10 additions & 1 deletion modules/swagger-jaxrs/src/test/java/io/swagger/ReaderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ public void scanImplicitParam() {
Swagger swagger = getSwagger(ResourceWithImplicitParams.class);
List<Parameter> params = swagger.getPath("/testString").getPost().getParameters();
assertNotNull(params);
assertEquals(params.size(), 8);
assertEquals(params.size(), 10);

assertEquals(params.get(0).getName(), "sort");
assertEquals(params.get(0).getIn(), "query");
Expand Down Expand Up @@ -278,6 +278,15 @@ public void scanImplicitParam() {
// see https://github.com/swagger-api/swagger-core/issues/2556. should be not null
assertNull(queryParam.getType());

QueryParameter selectByParam = (QueryParameter) params.get(8);
assertEquals(selectByParam.getName(), "select");
assertEquals(selectByParam.getIn(), "query");
assertEquals(selectByParam.getCollectionFormat(), "multi");

QueryParameter orderByParam = (QueryParameter) params.get(9);
assertEquals(orderByParam.getName(), "orderby");
assertEquals(orderByParam.getIn(), "query");
assertEquals(orderByParam.getCollectionFormat(), "csv");
}

@Test(description = "scan implicit params with file objct")
Expand Down
4 changes: 3 additions & 1 deletion modules/swagger-jaxrs/src/test/java/io/swagger/resources/ResourceWithImplicitParams.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ public class ResourceWithImplicitParams {
@ApiImplicitParam(name = "height", paramType = "query", dataType = "int", allowableValues = "range[3,4]"),
@ApiImplicitParam(name = "body", paramType = "body", dataType = "string", required = true),
@ApiImplicitParam(name = "width", paramType = "unknown"),
@ApiImplicitParam(name = "description", paramType = "query")
@ApiImplicitParam(name = "description", paramType = "query"),
@ApiImplicitParam(name = "select", type = "array", paramType = "query", dataTypeClass = String.class),
@ApiImplicitParam(name = "orderby", type = "array", paramType = "query", dataTypeClass = String.class, collectionFormat = "csv")
})
@ApiOperation("Test operation with implicit parameters")
public void testString() {
Expand Down
8 changes: 7 additions & 1 deletion ...gger-models/src/main/java/io/swagger/models/parameters/AbstractSerializableParameter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,13 @@ public String getType() {
@Override
public void setType(String type) {
this.type = type;
setCollectionFormat(ArrayProperty.isType(type) ? getDefaultCollectionFormat() : null);
if(ArrayProperty.isType(type)) {
if(getCollectionFormat() == null){
setCollectionFormat(getDefaultCollectionFormat());
}
} else {
setCollectionFormat(null);
}
}

@Override
Expand Down