Skip to content

refs #2794 - support @NotNull in parameter #2803

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 11, 2018
Merged

refs #2794 - support @NotNull in parameter #2803

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
2 changes: 2 additions & 0 deletions modules/swagger-core/src/main/java/io/swagger/v3/core/util/ParameterProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,8 @@ public static Parameter applyAnnotations(
} catch (Exception e) {
LOGGER.error("failed on " + annotation.annotationType().getName(), e);
}
} else if (annotation.annotationType().getName().equals("javax.validation.constraints.NotNull")) {
parameter.setRequired(true);
} else if (annotation.annotationType().getName().equals("javax.ws.rs.FormParam")) {
try {
String name = (String) annotation.annotationType().getMethod("value").invoke(annotation);
Expand Down
61 changes: 61 additions & 0 deletions modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/ReaderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
import io.swagger.v3.jaxrs2.resources.TestResource;
import io.swagger.v3.jaxrs2.resources.Ticket2644ConcreteImplementation;
import io.swagger.v3.jaxrs2.resources.Ticket2763Resource;
import io.swagger.v3.jaxrs2.resources.Ticket2794Resource;
import io.swagger.v3.jaxrs2.resources.UserAnnotationResource;
import io.swagger.v3.jaxrs2.resources.extensions.ExtensionsResource;
import io.swagger.v3.jaxrs2.resources.extensions.OperationExtensionsResource;
Expand Down Expand Up @@ -946,6 +947,66 @@ public void testTicket2763() {
" $ref: https://openebench.bsc.es/monitor/tool/tool.json";
SerializationMatchers.assertEqualsToYaml(openAPI, yaml);
}

@Test(description = "NotNull parameters")
public void testTicket2794() {
Reader reader = new Reader(new OpenAPI());

OpenAPI openAPI = reader.read(Ticket2794Resource.class);
String yaml = "openapi: 3.0.1\n" +
"paths:\n" +
" /notnullparameter:\n" +
" get:\n" +
" operationId: getBooks\n" +
" parameters:\n" +
" - name: page\n" +
" in: query\n" +
" required: true\n" +
" schema:\n" +
" type: integer\n" +
" format: int32\n" +
" responses:\n" +
" default:\n" +
" description: default response\n" +
" content:\n" +
" application/json: {}\n" +
" /notnullparameter/newnotnull:\n" +
" post:\n" +
" operationId: insertnotnull\n" +
" requestBody:\n" +
" content:\n" +
" '*/*':\n" +
" schema:\n" +
" $ref: '#/components/schemas/Book'\n" +
" required: true\n" +
" responses:\n" +
" default:\n" +
" description: default response\n" +
" content:\n" +
" '*/*': {}\n" +
" /notnullparameter/new_reqBody_required:\n" +
" post:\n" +
" operationId: insert\n" +
" requestBody:\n" +
" content:\n" +
" '*/*':\n" +
" schema:\n" +
" $ref: '#/components/schemas/Book'\n" +
" required: true\n" +
" responses:\n" +
" default:\n" +
" description: default response\n" +
" content:\n" +
" '*/*': {}\n" +
"components:\n" +
" schemas:\n" +
" Book:\n" +
" type: object\n" +
" properties:\n" +
" foo:\n" +
" type: string\n";
SerializationMatchers.assertEqualsToYaml(openAPI, yaml);
}
}


45 changes: 45 additions & 0 deletions modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/resources/Ticket2794Resource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
package io.swagger.v3.jaxrs2.resources;

import io.swagger.v3.oas.annotations.parameters.RequestBody;

import javax.validation.constraints.NotNull;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import java.util.Arrays;

@Path("/notnullparameter")
public class Ticket2794Resource
{
@Produces({ MediaType.APPLICATION_JSON })
@GET
public Response getBooks(
@QueryParam("page") @NotNull int page) {
return Response.ok(
Arrays.asList(
new Book(),
new Book()
)
).build();
}

@Path("/new_reqBody_required")
@POST
public Response insert(@RequestBody(required = true) Book book) {
return Response.ok().build();
}

@Path("/newnotnull")
@POST
public Response insertnotnull(@NotNull Book book) {
return Response.ok().build();
}

public static class Book {
public String foo;
}
}