Skip to content

refs #3092 - skip hidden properties in @BeanParam annotated schema #3580

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
Jun 4, 2020
Merged

refs #3092 - skip hidden properties in @BeanParam annotated schema #3580

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
17 changes: 17 additions & 0 deletions modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/DefaultParameterExtension.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
import io.swagger.v3.jaxrs2.ext.AbstractOpenAPIExtension;
import io.swagger.v3.jaxrs2.ext.OpenAPIExtension;
import io.swagger.v3.jaxrs2.ext.OpenAPIExtensions;
import io.swagger.v3.oas.annotations.Hidden;
import io.swagger.v3.oas.models.Components;
import io.swagger.v3.oas.models.parameters.Parameter;
import org.apache.commons.lang3.StringUtils;
Expand Down Expand Up @@ -223,6 +224,22 @@ private boolean handleAdditionalAnnotation(List<Parameter> parameters, List<Para
continue;
}

// skip hidden properties
boolean hidden = false;
for (Annotation a : paramAnnotations) {
if (a instanceof io.swagger.v3.oas.annotations.media.Schema) {
if (((io.swagger.v3.oas.annotations.media.Schema) a).hidden()) {
hidden = true;
break;
};
} else if (a instanceof Hidden) {
hidden = true;
break;
}
}
if (hidden) {
continue;
}
// Re-process all Bean fields and let the default swagger-jaxrs/swagger-jersey-jaxrs processors do their thing
ResolvedParameter resolvedParameter = extensions.next().extractParameters(
paramAnnotations,
Expand Down
55 changes: 55 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 @@ -60,6 +60,7 @@
import io.swagger.v3.jaxrs2.resources.Ticket2818Resource;
import io.swagger.v3.jaxrs2.resources.Ticket2848Resource;
import io.swagger.v3.jaxrs2.resources.Ticket3015Resource;
import io.swagger.v3.jaxrs2.resources.UploadResource;
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 @@ -2142,4 +2143,58 @@ public void testSingleExample() {
SerializationMatchers.assertEqualsToYaml(openAPI, yaml);
}

@Test
public void testTicket3092() {
Reader reader = new Reader(new OpenAPI());

OpenAPI openAPI = reader.read(UploadResource.class);
String yaml = "openapi: 3.0.1\n" +
"paths:\n" +
" /upload:\n" +
" post:\n" +
" operationId: uploadWithBean\n" +
" requestBody:\n" +
" content:\n" +
" multipart/form-data:\n" +
" schema:\n" +
" type: object\n" +
" properties:\n" +
" name:\n" +
" type: string\n" +
" picture:\n" +
" $ref: '#/components/schemas/picture'\n" +
" responses:\n" +
" default:\n" +
" description: default response\n" +
" content:\n" +
" application/json: {}\n" +
" /upload/requestbody:\n" +
" post:\n" +
" operationId: uploadWithBeanAndRequestBody\n" +
" requestBody:\n" +
" content:\n" +
" multipart/form-data:\n" +
" schema:\n" +
" $ref: '#/components/schemas/UploadRequest'\n" +
" responses:\n" +
" default:\n" +
" description: default response\n" +
" content:\n" +
" application/json: {}\n" +
"components:\n" +
" schemas:\n" +
" picture:\n" +
" type: object\n" +
" format: binary\n" +
" UploadRequest:\n" +
" title: Schema for Upload\n" +
" type: object\n" +
" properties:\n" +
" name:\n" +
" type: string\n" +
" picture:\n" +
" type: string\n" +
" format: binary";
SerializationMatchers.assertEqualsToYaml(openAPI, yaml);
}
}
57 changes: 57 additions & 0 deletions modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/resources/UploadRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
package io.swagger.v3.jaxrs2.resources;

import io.swagger.v3.oas.annotations.Hidden;
import io.swagger.v3.oas.annotations.media.Schema;
import org.glassfish.jersey.media.multipart.FormDataContentDisposition;
import org.glassfish.jersey.media.multipart.FormDataParam;

import java.io.InputStream;

@Schema(name = "UploadRequest", title="Schema for Upload")
public class UploadRequest {

@Hidden
@FormDataParam("picture")
private FormDataContentDisposition disposition;

public FormDataContentDisposition getDisposition() {
return disposition;
}
public void setDisposition(FormDataContentDisposition disposition) {
this.disposition = disposition;
}


@FormDataParam("name")
private String name;

public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}


@Schema(name="picture", type="string", format="binary")
@FormDataParam("picture")
private InputStream upload;


public InputStream getUpload() {
return upload;
}
public void setUpload(InputStream upload) {
this.upload = upload;
}

@Override
public String toString() {
final String NL = System.lineSeparator();
StringBuilder sb = new StringBuilder();
sb.append(super.toString());
sb.append("name: ").append(name).append(NL);
return sb.toString();
}

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

import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.parameters.RequestBody;

import javax.ws.rs.BeanParam;
import javax.ws.rs.Consumes;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;


@Path("/upload")
public class UploadResource {

@POST
@Consumes(MediaType.MULTIPART_FORM_DATA)
@Produces(MediaType.APPLICATION_JSON)
public Response uploadWithBean(@BeanParam UploadRequest personData) {
return Response.ok().build();
}

@Path("/requestbody")
@POST
@Consumes(MediaType.MULTIPART_FORM_DATA)
@Produces(MediaType.APPLICATION_JSON)
@RequestBody(content = @Content(schema = @Schema(implementation = UploadRequest.class)))
public Response uploadWithBeanAndRequestBody(@BeanParam UploadRequest personData) {
return Response.ok().build();
}
}