Add error sources annotation

Add common API

Author: sibmaks

build.gradle.kts

@@ -29,6 +29,8 @@ dependencies {
 
     implementation("jakarta.annotation:jakarta.annotation-api:${project.property("lib_annotation_api_version")}")
 
+    implementation("com.github.simple-mocks:api-common:${project.property("lib_api_common_version")}")
+
 }
 
 tasks.withType<JavaCompile>().configureEach {

gradle.properties

@@ -7,8 +7,11 @@ jdk_version=21
 author=Simple Mocks
 project_name=api-error
 group=com.github.simple-mocks
-version=0.0.12
+version=0.0.13
 
 # 3rd party libraries
 lib_lombok_version=1.18.32
-lib_annotation_api_version=3.0.0
+lib_annotation_api_version=3.0.0
+
+# service APIs deps
+lib_api_common_version=0.0.1

src/main/java/com/github/simplemocks/error_service/api/dto/LocalizedError.java

@@ -5,6 +5,8 @@
 import lombok.NoArgsConstructor;
 import lombok.Setter;
 
+import java.io.Serializable;
+
 /**
  * Localized error dto
  *
@@ -15,7 +17,7 @@
 @Setter
 @NoArgsConstructor
 @AllArgsConstructor
-public class LocalizedError {
+public class LocalizedError implements Serializable {
     /**
      * Human-readable title
      */

src/main/java/com/github/simplemocks/error_service/api/rs/LocalizeErrorRs.java

@@ -0,0 +1,26 @@
+package com.github.simplemocks.error_service.api.rs;
+
+import com.github.simplemocks.common.api.rs.StandardBodyRs;
+import com.github.simplemocks.error_service.api.dto.LocalizedError;
+import jakarta.annotation.Nullable;
+import lombok.Builder;
+
+/**
+ * Localize error response dto
+ *
+ * @author sibmaks
+ * @since 0.0.1
+ */
+@Builder
+public class LocalizeErrorRs extends StandardBodyRs<LocalizedError> {
+
+    /**
+     * Construct localize error response
+     *
+     * @param localizedError localized error
+     */
+    public LocalizeErrorRs(@Nullable LocalizedError localizedError) {
+        super(localizedError);
+    }
+
+}

src/main/java/com/github/simplemocks/error_service/api/service/ErrorService.java

@@ -1,8 +1,8 @@
 package com.github.simplemocks.error_service.api.service;
 
 
-import com.github.simplemocks.error_service.api.dto.LocalizedError;
 import com.github.simplemocks.error_service.api.rq.LocalizeErrorRq;
+import com.github.simplemocks.error_service.api.rs.LocalizeErrorRs;
 import jakarta.annotation.Nonnull;
 
 /**
@@ -20,6 +20,6 @@ public interface ErrorService {
      * @return description of error or null
      */
     @Nonnull
-    LocalizedError localize(@Nonnull LocalizeErrorRq rq);
+    LocalizeErrorRs localize(@Nonnull LocalizeErrorRq rq);
 
 }

src/main/java/com/github/simplemocks/error_service/mutable/api/source/ErrorLocalizationsJsonSource.java

@@ -0,0 +1,46 @@
+package com.github.simplemocks.error_service.mutable.api.source;
+
+import com.github.simplemocks.error_service.api.dto.ErrorSourceId;
+
+import java.lang.annotation.*;
+
+/**
+ * Error localizations source annotation
+ *
+ * @author sibmaks
+ * @since 0.0.13
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.TYPE)
+@Documented
+@Repeatable(ErrorLocalizationsJsonSources.class)
+public @interface ErrorLocalizationsJsonSource {
+
+    /**
+     * Error source system code
+     *
+     * @return system code
+     */
+    String systemCode();
+
+    /**
+     * Error kind code
+     *
+     * @return kind code
+     */
+    String kindCode() default ErrorSourceId.DEFAULT_KIND_CODE;
+
+    /**
+     * Locale iso3 code
+     *
+     * @return iso3 language code
+     */
+    String iso3Code();
+
+    /**
+     * Path to json file
+     *
+     * @return path to file
+     */
+    String path();
+}

src/main/java/com/github/simplemocks/error_service/mutable/api/source/ErrorLocalizationsJsonSources.java

@@ -0,0 +1,23 @@
+package com.github.simplemocks.error_service.mutable.api.source;
+
+import java.lang.annotation.*;
+
+/**
+ * Localization source annotation
+ *
+ * @author sibmaks
+ * @since 0.0.3
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.TYPE)
+@Documented
+public @interface ErrorLocalizationsJsonSources {
+
+    /**
+     * All localization JSON sources
+     *
+     * @return localization sources
+     */
+    ErrorLocalizationsJsonSource[] value();
+
+}