Add X-File-Size header to validation requests

veraPDF · Nov 27, 2023 · 4842603 · 4842603
1 parent aaa5100
commit 4842603
Show file tree

Hide file tree

Showing 5 changed files with 91 additions and 61 deletions.
diff --git a/README.md b/README.md
@@ -205,6 +205,13 @@ and use curl:
 curl -F "url=file:///home/folder/pdf.pdf" localhost:8080/api/validate/url/1b
 ```
 
+To add file size in validation POST requests you need to send request with header (key `X-File-Size` and value in bytes). 
+For example to use  request `http://localhost:8080/api/validate/url/*id*` with file which size is 300 KB run:
+
+```
+curl -H "X-File-Size: 307200" -F "url=http://www.pdf995.com/samples/pdf.pdf" localhost:8080/api/validate/url/auto 
+```
+
 ### veraPDF configuration parameters
 Configuration parameters are located in `/opt/verapdf-rest/config` folder of the container file system. The details on the veraPDF parameters are available at https://docs.verapdf.org/cli/config/. 
 

diff --git a/src/main/java/org/verapdf/rest/resources/ApiResource.java b/src/main/java/org/verapdf/rest/resources/ApiResource.java
@@ -70,9 +70,9 @@ public static ReleaseDetails getReleaseDetails() {
 	@ApiResponses(value = {
 			@ApiResponse(responseCode = "200", description = "OK", content = {
 					@Content(mediaType = "application/json", schema =
-					@Schema(implementation = ReleaseDetails.class)
+					@Schema(implementation = Environment.class)
 					), @Content(mediaType = "application/xml", schema =
-			@Schema(implementation = ReleaseDetails.class)
+			@Schema(implementation = Environment.class)
 			)})})
 	@Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
 	public static Environment getEnvironment() {

diff --git a/src/main/java/org/verapdf/rest/resources/ByteStreamResource.java b/src/main/java/org/verapdf/rest/resources/ByteStreamResource.java
@@ -14,7 +14,6 @@
 import org.glassfish.jersey.media.multipart.FormDataParam;
 import org.openpreservation.bytestreams.ByteStreamId;
 import org.openpreservation.bytestreams.ByteStreams;
-import org.verapdf.ReleaseDetails;
 
 import javax.ws.rs.*;
 import javax.ws.rs.core.MediaType;
@@ -52,11 +51,11 @@ public ByteStreamResource() {
 	@ApiResponses(value = {
 			@ApiResponse(responseCode = "200", description = "OK", content = {
 					@Content(mediaType = "application/xml", schema =
-					@Schema(implementation = ReleaseDetails.class)),
+					@Schema(implementation = ByteStreamId.class)),
 					@Content(mediaType = "application/json", schema =
-					@Schema(implementation = ReleaseDetails.class)),
+					@Schema(implementation = ByteStreamId.class)),
 					@Content(mediaType = "text/xml", schema =
-					@Schema(implementation = ReleaseDetails.class))
+					@Schema(implementation = ByteStreamId.class))
 			})})
 	@Consumes(MediaType.MULTIPART_FORM_DATA)
 	@Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML,
@@ -88,11 +87,11 @@ public static ByteStreamId getSha1(
 	@ApiResponses(value = {
 			@ApiResponse(responseCode = "200", description = "OK", content = {
 					@Content(mediaType = "application/xml", schema =
-					@Schema(implementation = ReleaseDetails.class)),
+					@Schema(implementation = ByteStreamId.class)),
 					@Content(mediaType = "application/json", schema =
-					@Schema(implementation = ReleaseDetails.class)),
+					@Schema(implementation = ByteStreamId.class)),
 					@Content(mediaType = "text/xml", schema =
-					@Schema(implementation = ReleaseDetails.class))
+					@Schema(implementation = ByteStreamId.class))
 			})})
 	@Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML,
 	           MediaType.TEXT_XML})

diff --git a/src/main/java/org/verapdf/rest/resources/ProfileResource.java b/src/main/java/org/verapdf/rest/resources/ProfileResource.java
@@ -9,7 +9,6 @@
 import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.responses.ApiResponses;
-import org.verapdf.ReleaseDetails;
 import org.verapdf.pdfa.flavours.PDFAFlavour;
 import org.verapdf.pdfa.validation.profiles.*;
 
@@ -46,9 +45,9 @@ public class ProfileResource {
 	@ApiResponses(value = {
 			@ApiResponse(responseCode = "200", description = "OK", content = {
 					@Content(mediaType = "application/json", schema =
-					@Schema(implementation = ReleaseDetails.class)
+					@Schema(implementation = ProfileDetails.class)
 					), @Content(mediaType = "application/xml", schema =
-			@Schema(implementation = ReleaseDetails.class)
+			@Schema(implementation = ProfileDetails.class)
 			)})})
 	@Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
 	public static Set<ProfileDetails> getProfileDetails() {
@@ -64,9 +63,9 @@ public static Set<ProfileDetails> getProfileDetails() {
 	@ApiResponses(value = {
 			@ApiResponse(responseCode = "200", description = "OK", content = {
 					@Content(mediaType = "application/json", schema =
-					@Schema(implementation = ReleaseDetails.class)
+					@Schema(implementation = String.class)
 					), @Content(mediaType = "application/xml", schema =
-			@Schema(implementation = ReleaseDetails.class)
+			@Schema(implementation = String.class)
 			)})})
 	@Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
 	public static Set<String> getProfileIds() {
@@ -82,9 +81,9 @@ public static Set<String> getProfileIds() {
 	@ApiResponses(value = {
 			@ApiResponse(responseCode = "200", description = "OK", content = {
 					@Content(mediaType = "application/json", schema =
-					@Schema(implementation = ReleaseDetails.class)
+					@Schema(implementation = PDFAFlavour.class)
 					), @Content(mediaType = "application/xml", schema =
-			@Schema(implementation = ReleaseDetails.class)
+			@Schema(implementation = PDFAFlavour.class)
 			)})})
 	@Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
 	public static Set<PDFAFlavour> getFlavours() {
@@ -103,9 +102,9 @@ public static Set<PDFAFlavour> getFlavours() {
 	@ApiResponses(value = {
 			@ApiResponse(responseCode = "200", description = "OK", content = {
 					@Content(mediaType = "application/json", schema =
-					@Schema(implementation = ReleaseDetails.class)
+					@Schema(implementation = ValidationProfile.class)
 					), @Content(mediaType = "application/xml", schema =
-			@Schema(implementation = ReleaseDetails.class)
+			@Schema(implementation = ValidationProfile.class)
 			)})})
 	@Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
 	public static ValidationProfile getProfile(@Parameter(description = "the String id of the Validation profile " +
@@ -128,9 +127,9 @@ public static ValidationProfile getProfile(@Parameter(description = "the String
 	@ApiResponses(value = {
 			@ApiResponse(responseCode = "200", description = "OK", content = {
 					@Content(mediaType = "application/json", schema =
-					@Schema(implementation = ReleaseDetails.class)
+					@Schema(implementation = RuleId.class)
 					), @Content(mediaType = "application/xml", schema =
-			@Schema(implementation = ReleaseDetails.class)
+			@Schema(implementation = RuleId.class)
 			)})})
 	@Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
 	public static Set<RuleId> getProfileRules(@Parameter(description = "the String id of the Validation profile " +
@@ -160,9 +159,9 @@ public static Set<RuleId> getProfileRules(@Parameter(description = "the String i
 	@ApiResponses(value = {
 			@ApiResponse(responseCode = "200", description = "OK", content = {
 					@Content(mediaType = "application/json", schema =
-					@Schema(implementation = ReleaseDetails.class)
+					@Schema(implementation = Rule.class)
 					), @Content(mediaType = "application/xml", schema =
-			@Schema(implementation = ReleaseDetails.class)
+			@Schema(implementation = Rule.class)
 			)})})
 	@Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
 	public static Set<Rule> getRulesForClause(@Parameter(description = "the String id of the Validation profile " +