Merge pull request #27

add example values for the swagger spec
knaw-huc · Mar 29, 2021 · 3b626b2 · 3b626b2
2 parents baf52c4 + b34e976
commit 3b626b2
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 3 deletions.
diff --git a/textrepo-app/src/main/java/nl/knaw/huc/api/FormDocument.java b/textrepo-app/src/main/java/nl/knaw/huc/api/FormDocument.java
@@ -3,12 +3,14 @@
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.google.common.base.MoreObjects;
+import io.swagger.annotations.ApiModelProperty;
 
 import javax.validation.constraints.NotBlank;
 
 public class FormDocument {
 
   @NotBlank(message = "is mandatory")
+  @ApiModelProperty(example = "document_1234")
   private final String externalId;
 
   @JsonCreator

diff --git a/textrepo-app/src/main/java/nl/knaw/huc/api/FormTextRepoFile.java b/textrepo-app/src/main/java/nl/knaw/huc/api/FormTextRepoFile.java
@@ -3,16 +3,19 @@
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.google.common.base.MoreObjects;
+import io.swagger.annotations.ApiModelProperty;
 
 import javax.validation.constraints.NotNull;
 import java.util.UUID;
 
 public class FormTextRepoFile {
 
   @NotNull(message = "is mandatory")
+  @ApiModelProperty(example = "34739357-eb75-449b-b2df-d3f6289470d6")
   private UUID docId;
 
   @NotNull(message = "is mandatory")
+  @ApiModelProperty(example = "1")
   private Short typeId;
 
   @JsonCreator

diff --git a/textrepo-app/src/main/java/nl/knaw/huc/api/FormType.java b/textrepo-app/src/main/java/nl/knaw/huc/api/FormType.java
@@ -3,15 +3,18 @@
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.google.common.base.MoreObjects;
+import io.swagger.annotations.ApiModelProperty;
 
 import javax.validation.constraints.NotBlank;
 
 public class FormType {
 
   @NotBlank(message = "is mandatory")
+  @ApiModelProperty(example = "plaintext")
   private final String name;
 
   @NotBlank(message = "is mandatory")
+  @ApiModelProperty(example = "text/plain")
   private final String mimetype;
 
   @JsonCreator

diff --git a/textrepo-app/src/main/java/nl/knaw/huc/api/FormVersion.java b/textrepo-app/src/main/java/nl/knaw/huc/api/FormVersion.java
@@ -3,12 +3,14 @@
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.google.common.base.MoreObjects;
+import io.swagger.annotations.ApiModelProperty;
 
 import javax.validation.constraints.NotBlank;
 
 public class FormVersion {
 
   @NotBlank(message = "is mandatory")
+  @ApiModelProperty(example = "document_1234")
   private final String externalId;
 
   @JsonCreator

diff --git a/textrepo-app/src/main/java/nl/knaw/huc/resources/rest/FileVersionsResource.java b/textrepo-app/src/main/java/nl/knaw/huc/resources/rest/FileVersionsResource.java
@@ -6,6 +6,7 @@
 import io.swagger.annotations.ApiResponse;
 import io.swagger.annotations.ApiResponses;
 import nl.knaw.huc.api.FormPageParams;
+import nl.knaw.huc.api.ResultPage;
 import nl.knaw.huc.api.ResultVersion;
 import nl.knaw.huc.helpers.Paginator;
 import nl.knaw.huc.service.version.VersionService;
@@ -48,7 +49,7 @@ public FileVersionsResource(
   @Timed
   @Produces(APPLICATION_JSON)
   @ApiOperation("Retrieve file versions, newest first")
-  @ApiResponses({@ApiResponse(code = 200, response = ResultVersion.class, message = "OK")})
+  @ApiResponses({@ApiResponse(code = 200, response = ResultPage.class, message = "OK")})
   public Response getFileVersions(
       @PathParam("fileId") @Valid UUID fileId,
       @BeanParam FormPageParams pageParams,

diff --git a/textrepo-app/src/main/java/nl/knaw/huc/resources/rest/VersionContentsResource.java b/textrepo-app/src/main/java/nl/knaw/huc/resources/rest/VersionContentsResource.java
@@ -5,7 +5,6 @@
 import io.swagger.annotations.ApiOperation;
 import io.swagger.annotations.ApiResponse;
 import io.swagger.annotations.ApiResponses;
-import nl.knaw.huc.api.ResultVersion;
 import nl.knaw.huc.exceptions.MethodNotAllowedException;
 import nl.knaw.huc.helpers.ContentsHelper;
 import nl.knaw.huc.service.version.content.VersionContentsService;
@@ -58,7 +57,7 @@ public Response postVersionContentsIsNotAllowed() {
   @Timed
   @Produces(APPLICATION_JSON)
   @ApiOperation(value = "Retrieve version contents")
-  @ApiResponses(value = {@ApiResponse(code = 200, response = ResultVersion.class, message = "OK")})
+  @ApiResponses(value = {@ApiResponse(code = 200, response = byte[].class, message = "OK")})
   public Response getVersionContents(
       @HeaderParam(ACCEPT_ENCODING) String acceptEncoding,
       @PathParam("versionId") @NotNull @Valid UUID versionId