Update version to 1.8.0

Update packages dependencies Add error links object support Update doc

Author: devslm

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [1.8.0] - 2022-11-01
+### Added:
+ - Error links object support
+
+### Changed:
+ - Update all dependencies versions
+
 ## [1.7.0] - 2022-08-22
 ### Added:
  - Methods to get typed params from filter (i.e. **stringValue**, **listOfUuidValues** etc.)

README.md

@@ -16,7 +16,7 @@ Add dependency to your project:
 <dependency>
  <groupId>com.slm-dev</groupId>
  <artifactId>jsonapi-simple</artifactId>
- <version>1.7.0</version>
+ <version>1.8.0</version>
 </dependency>
 ```
 
@@ -464,15 +464,15 @@ public class Test {
 }
 ```
 
-Example response with error (data is empty so we use ```Void``` class as generic parameter):
+Example response with error (data is empty, so we use ```Void``` class as generic parameter):
 ```java
 // Pseudo code
 public class Test {
  public Response<Void> main() {
  return Response.<Void, Void>builder()
  .error(
  HttpStatus.BAD_REQUEST,
- "TOKEN_ERROR",
+ "20045",
  "Some errors occurred!"
  ).build();
  }
@@ -483,7 +483,7 @@ public class Test {
  "errors": [
  {
  "status": 400,
- "code": "TOKEN_ERROR",
+ "code": "20045",
  "detail": "Some errors occurred!"
  }
  ],
@@ -499,6 +499,50 @@ public class Test {
 }
 ```
 
+Example response with error with links (data is empty, so we use ```Void``` class as generic parameter):
+```java
+// Pseudo code
+public class Test {
+ public Response<Void> main() {
+ final Error.ErrorLink errorLink = Error.ErrorLink
+ .builder()
+ .about("https://example.org/docs/TOKEN_ERROR")
+ .build();
+ 
+ return Response.<Void, Void>builder()
+ .error(
+ HttpStatus.BAD_REQUEST,
+ "20045",
+ "Some errors occurred!",
+ errorLink
+ ).build();
+ }
+}
+```
+```json
+{
+ "errors": [
+ {
+ "status": 400,
+ "code": "20045",
+ "detail": "Some errors occurred!",
+ "links": {
+ "about": "https://example.org/docs/20045"
+ }
+ }
+ ],
+ "meta": {
+ "api": {
+ "version": "1"
+ },
+ "page": {
+ "maxSize": 25,
+ "total": 0
+ }
+ }
+}
+```
+
 Example response with validation error and field name with invalid data (data is empty so we use ```Void``` 
 class as generic parameter):
 ```java

pom.xml

@@ -4,7 +4,7 @@
 <modelVersion>4.0.0</modelVersion>
 <groupId>com.slm-dev</groupId>
 <artifactId>jsonapi-simple</artifactId>
-<version>1.7.0</version>
+<version>1.8.0</version>
 <name>jsonapi-simple</name>
 <description>Simple implementation of the JSON:API specification</description>
 <url>https://slm-dev.com/jsonapi-simple/</url>
@@ -35,15 +35,16 @@
 <properties>
 <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 <java.version>11</java.version>
-<spring.web.version>5.3.22</spring.web.version>
-<spring.data.commons.version>2.7.2</spring.data.commons.version>
+<spring.web.version>5.3.23</spring.web.version>
+<spring.data.commons.version>2.7.5</spring.data.commons.version>
 <lombok.version>1.18.24</lombok.version>
 <lombok.maven.plugin.version>1.18.20.0</lombok.maven.plugin.version>
-<jackson.version>2.13.3</jackson.version>
+<jackson.version>2.13.4.2</jackson.version>
+<jackson.datatype.version>2.13.4</jackson.datatype.version>
 <sprinfox.version>3.0.0</sprinfox.version>
 <junit.version>5.9.0</junit.version>
 <hamcrest.version>2.2</hamcrest.version>
-<mockito.version>4.7.0</mockito.version>
+<mockito.version>4.8.0</mockito.version>
 <maven.compiler.version>3.10.1</maven.compiler.version>
 <maven.surefire.version>2.22.2</maven.surefire.version>
 <maven.deploy.version>2.8.2</maven.deploy.version>
@@ -81,7 +82,7 @@
 <dependency>
 <groupId>com.fasterxml.jackson.datatype</groupId>
 <artifactId>jackson-datatype-jsr310</artifactId>
-<version>${jackson.version}</version>
+<version>${jackson.datatype.version}</version>
 </dependency>
 
 <dependency>

src/main/java/com/slmdev/jsonapi/simple/response/Error.java

@@ -2,10 +2,7 @@
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import io.swagger.annotations.ApiModelProperty;
-import lombok.AllArgsConstructor;
-import lombok.Getter;
-import lombok.NoArgsConstructor;
-import lombok.ToString;
+import lombok.*;
 import lombok.experimental.Accessors;
 
 @Getter
@@ -21,8 +18,9 @@ public class Error {
  private String code;
  @ApiModelProperty(value = "Error detail message", required = true)
  private String detail;
- @ApiModelProperty(value = "Parameter name only for validation errors", required = false)
+ @ApiModelProperty(value = "Parameter name only for validation errors")
  private Source source;
+ private ErrorLink links;
 
  @Getter
  @ToString
@@ -33,4 +31,18 @@ public class Error {
  public static class Source {
  private String parameter;
  }
+
+ @Getter
+ @ToString
+ @Builder
+ @NoArgsConstructor
+ @AllArgsConstructor
+ @Accessors(chain = true)
+ @JsonInclude(JsonInclude.Include.NON_NULL)
+ public static class ErrorLink {
+ @ApiModelProperty(value = "A link that leads to further details about this particular occurrence of the problem")
+ private String about;
+ @ApiModelProperty(value = "A link that identifies the type of error that this particular error is an instance of")
+ private String type;
+ }
 }

src/main/java/com/slmdev/jsonapi/simple/response/Response.java

@@ -345,7 +345,8 @@ public ResponseBuilder<T, V> validationError(final @NonNull String errorValidati
  HttpStatus.BAD_REQUEST,
  "VALIDATION_ERROR",
  detail,
- errorValidationField
+ errorValidationField,
+ null
  );
  }
 
@@ -357,7 +358,7 @@ public ResponseBuilder<T, V> validationError(final @NonNull String errorValidati
  * @return self link
  */
  public ResponseBuilder<T, V> error(final HttpStatus status, final String detail) {
- return error(status, null, detail, null);
+ return error(status, null, detail, null, null);
  }
 
  /**
@@ -369,7 +370,7 @@ public ResponseBuilder<T, V> error(final HttpStatus status, final String detail)
  * @return self link
  */
  public ResponseBuilder<T, V> error(final HttpStatus status, final String code, final String detail) {
- return error(status, code, detail, null);
+ return error(status, code, detail, null, null);
  }
 
  /**
@@ -388,6 +389,46 @@ public ResponseBuilder<T, V> error(final HttpStatus status,
  final String code,
  final @NonNull String detail,
  final String errorValidationField) {
+ return error(status, code, detail, errorValidationField, null);
+ }
+
+ /**
+ * Create errors object.
+ *
+ * <p>We can invoke this method as many times as we need and
+ * result object will contain all errors we passed.
+ *
+ * @param status spring {@link HttpStatus} object
+ * @param code internal error code (if exists)
+ * @param detail detail information about error
+ * @param links field with links for the details about error
+ * @return self link
+ */
+ public ResponseBuilder<T, V> error(final HttpStatus status,
+ final String code,
+ final @NonNull String detail,
+ final Error.ErrorLink links) {
+ return error(status, code, detail, null, links);
+ }
+
+ /**
+ * Create errors object.
+ *
+ * <p>We can invoke this method as many times as we need and
+ * result object will contain all errors we passed.
+ *
+ * @param status spring {@link HttpStatus} object
+ * @param code internal error code (if exists)
+ * @param detail detail information about error
+ * @param errorValidationField field with failed validation
+ * @param links field with links for the details about error
+ * @return self link
+ */
+ public ResponseBuilder<T, V> error(final HttpStatus status,
+ final String code,
+ final @NonNull String detail,
+ final String errorValidationField,
+ final Error.ErrorLink links) {
  if (this.errors == null) {
  this.errors = new ArrayList<>();
  }
@@ -397,7 +438,7 @@ public ResponseBuilder<T, V> error(final HttpStatus status,
  errorSource = new Error.Source(errorValidationField);
  }
  this.errors.add(
- new Error(status.value(), code, detail, errorSource)
+ new Error(status.value(), code, detail, errorSource, links)
  );
  this.dataList = null;
  this.dataObject = null;

src/test/java/com/slmdev/jsonapi/simple/response/ResponseTest.java

@@ -224,6 +224,22 @@ public void shouldReturnResponseWithValidationErrorWithEmptyData() {
 assertThat(response.getErrors().get(0).getSource().getParameter(), is("someField"));
 }
 
+@Test
+public void shouldReturnResponseWithErrorWithLinkAndWith() {
+final Error.ErrorLink errorLink = Error.ErrorLink
+.builder()
+.about("https://example.org/docs/" + ERROR_CODE)
+.build();
+
+final Response<Void> response = Response.<Void, Void>builder()
+.error(HttpStatus.BAD_REQUEST, ERROR_CODE, ERROR_DESCRIPTION, errorLink)
+.build();
+
+assertErrorResponse(response);
+
+assertThat(response.getErrors().get(0).getLinks().getAbout(), is(errorLink.getAbout()));
+}
+
 @Test
 public void shouldReturnResponseWithEmptyDataAndChangedMetaVersion() {
 final Response<Void> response = Response.<Void, Void>builder()