Add swagger annotations (#125)

Author: carlosthe19916

pom.xml

@@ -92,6 +92,17 @@
             <version>${quarkus.version}</version>
         </dependency>
 
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>2.13.3</version>
+        </dependency>
+        <dependency>
+            <groupId>io.swagger.core.v3</groupId>
+            <artifactId>swagger-annotations</artifactId>
+            <version>2.2.4</version>
+        </dependency>
+
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter-engine</artifactId>

src/main/java/io/github/project/openubl/xbuilder/content/catalogs/Catalog.java

@@ -25,9 +25,9 @@ public interface Catalog {
         new IllegalStateException("No se pudo convertir el valor del catálogo");
 
     /**
-     * @param <T> Class you want to search for
+     * @param <T>      Class you want to search for
      * @param enumType class you want to search for
-     * @param code the code or Enum value
+     * @param code     the code or Enum value
      * @return an instance of Catalog which is equal to ValueOf or contains the same code
      */
     static <T extends Catalog> Optional<T> valueOfCode(Class<T> enumType, String code) {

src/main/java/io/github/project/openubl/xbuilder/content/models/common/Cliente.java

@@ -17,6 +17,7 @@
 package io.github.project.openubl.xbuilder.content.models.common;
 
 import io.github.project.openubl.xbuilder.content.catalogs.Catalog6;
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Data;
@@ -40,18 +41,21 @@ public class Cliente {
      * <p>
      * Valores válidos: {@link Catalog6}
      */
+    @Schema(description = "Catalogo 06", required = true)
     private String tipoDocumentoIdentidad;
 
     /**
      * Número de documento de identidad del cliente.
      */
+    @Schema(required = true)
     private String numeroDocumentoIdentidad;
 
     /**
      * Nombre del cliente. Si el cliente es personal natural entonces
      * es el nombre y apellidos de la persona; si el cliente es una persona jurídica
      * entonces es la razón social de la empresa.
      */
+    @Schema(required = true)
     private String nombre;
 
     /**

src/main/java/io/github/project/openubl/xbuilder/content/models/common/Contacto.java

@@ -16,6 +16,7 @@
  */
 package io.github.project.openubl.xbuilder.content.models.common;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Data;
@@ -35,10 +36,12 @@ public class Contacto {
     /**
      * Número telefónico
      */
+    @Schema(description = "Número telefónico")
     private String telefono;
 
     /**
      * Correo electrónico
      */
+    @Schema(description = "Correo electrónico")
     private String email;
 }

src/main/java/io/github/project/openubl/xbuilder/content/models/common/Direccion.java

@@ -16,6 +16,7 @@
  */
 package io.github.project.openubl.xbuilder.content.models.common;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Data;
@@ -35,6 +36,12 @@ public class Direccion {
     /**
      * Código de 6 dígitos que corresponden al Departamento, Provincia, y Distrito
      */
+    @Schema(
+        description = "Código de 6 dígitos que corresponden al Departamento, Provincia, y Distrito",
+        minLength = 6,
+        maxLength = 6,
+        pattern = "[0-9]+"
+    )
     private String ubigeo;
 
     /**
@@ -43,35 +50,51 @@ public class Direccion {
      * establecimiento. Tratándose del domicilio fiscal y en el caso de no poder determinar el lugar
      * de la venta, informar “0000”.
      */
+    @Schema(
+        description = "Código de cuatro dígitos asignado por SUNAT, que identifica al establecimiento anexo. Dicho código se genera al momento la respectiva comunicación del establecimiento. Tratándose del domicilio fiscal y en el caso de no poder determinar el lugar de la venta, informar \"0000\"",
+        minLength = 4,
+        maxLength = 4,
+        pattern = "[0-9]+"
+    )
     private String codigoLocal;
 
     /**
      * Nombre de la urbanización.
      */
+    @Schema(description = "Nombre de la urbanización.")
     private String urbanizacion;
 
     /**
      * Nombre del Departamento o Región. Ejemplo: Ayacucho
      */
+    @Schema(description = "Nombre del Departamento o Región. Ejemplo: Ayacucho")
     private String departamento;
 
     /**
      * Nombre de la Provincia. Ejemplo: Huamanga
      */
+    @Schema(description = "Nombre de la Provincia. Ejemplo: Huamanga")
     private String provincia;
 
     /**
      * Nombre del Distrito. Ejemplo: Quinua
      */
+    @Schema(description = "Nombre del Distrito. Ejemplo: Quinua")
     private String distrito;
 
     /**
      * Dirección. Ejemplo: Jirón las piedras 123
      */
+    @Schema(description = "Dirección. Ejemplo: Jirón las piedras 123")
     private String direccion;
 
     /**
      * Código de 2 dígitos que corresponde al país a la que pertenece la dirección. Ejemplo: PE
      */
+    @Schema(
+        description = "Código de 2 dígitos que corresponde al país a la que pertenece la dirección. Ejemplo: PE",
+        minLength = 2,
+        maxLength = 2
+    )
     private String codigoPais;
 }

src/main/java/io/github/project/openubl/xbuilder/content/models/common/Firmante.java

@@ -16,6 +16,7 @@
  */
 package io.github.project.openubl.xbuilder.content.models.common;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Data;
@@ -35,10 +36,12 @@ public class Firmante {
     /**
      * Número de RUC de la persona
      */
+    @Schema(required = true, minLength = 11, maxLength = 11, pattern = "[0-9]+")
     private String ruc;
 
     /**
      * Razón social de la persona
      */
+    @Schema(required = true)
     private String razonSocial;
 }

src/main/java/io/github/project/openubl/xbuilder/content/models/common/Proveedor.java

@@ -16,6 +16,7 @@
  */
 package io.github.project.openubl.xbuilder.content.models.common;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Data;
@@ -35,6 +36,7 @@ public class Proveedor {
     /**
      * Número de RUC de la persona jurídica
      */
+    @Schema(required = true, minLength = 11, maxLength = 11, pattern = "[0-9]+")
     private String ruc;
 
     /**
@@ -45,6 +47,7 @@ public class Proveedor {
     /**
      * Razón social de la persona jurídica
      */
+    @Schema(required = true)
     private String razonSocial;
 
     /**

src/main/java/io/github/project/openubl/xbuilder/content/models/standard/general/Anticipo.java

@@ -16,6 +16,8 @@
  */
 package io.github.project.openubl.xbuilder.content.models.standard.general;
 
+import io.github.project.openubl.xbuilder.content.catalogs.Catalog53_Anticipo;
+import io.swagger.v3.oas.annotations.media.Schema;
 import java.math.BigDecimal;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
@@ -42,20 +44,25 @@ public class Anticipo {
      * <p>
      * Valores válidos: "04", "05", "06"
      */
+    @Schema(example = "04", description = "Catalog 53", required = true, allowableValues = { "04", "05", "06" })
     private String tipo;
 
     /**
      * Serie y número de comprobante del anticipo, por ejemplo "F123-4"
      */
+    @Schema(example = "F123-4", required = true)
     private String comprobanteSerieNumero;
 
     /**
+     * Catalog 12
      * Código de tipo de documento del {@link #comprobanteSerieNumero}.
      */
+    @Schema(description = "Catalog 12. Tipo de documento del comprobante de anticipo")
     private String comprobanteTipo;
 
     /**
      * Monto prepagado o anticipado
      */
+    @Schema(example = "10", required = true, minimum = "0", exclusiveMinimum = true)
     private BigDecimal monto;
 }

src/main/java/io/github/project/openubl/xbuilder/content/models/standard/general/CargoDescuento.java

@@ -19,9 +19,7 @@
 import java.math.BigDecimal;
 import lombok.AllArgsConstructor;
 import lombok.Data;
-import lombok.EqualsAndHashCode;
 import lombok.NoArgsConstructor;
-import lombok.ToString;
 import lombok.experimental.SuperBuilder;
 
 @Data

src/main/java/io/github/project/openubl/xbuilder/content/models/standard/general/CreditNote.java

@@ -16,17 +16,18 @@
  */
 package io.github.project.openubl.xbuilder.content.models.standard.general;
 
-import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.NoArgsConstructor;
 import lombok.experimental.SuperBuilder;
+import lombok.extern.jackson.Jacksonized;
 
 /**
  * Clase base para CreditNote y DebitNote.
  *
  * @author <a href="mailto:carlosthe19916@gmail.com">Carlos Feria</a>
  */
+@Jacksonized
 @Data
 @SuperBuilder
 @NoArgsConstructor

src/main/java/io/github/project/openubl/xbuilder/content/models/standard/general/CuotaDePago.java

@@ -16,6 +16,7 @@
  */
 package io.github.project.openubl.xbuilder.content.models.standard.general;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import java.math.BigDecimal;
 import java.time.LocalDate;
 import lombok.AllArgsConstructor;
@@ -37,10 +38,12 @@ public class CuotaDePago {
     /**
      * Importe de la cuota
      */
+    @Schema(required = true, minimum = "0", exclusiveMinimum = true)
     private BigDecimal importe;
 
     /**
      * Fecha de pago de la cuota
      */
+    @Schema(description = "Ejemplo 2022-12-25", required = true, pattern = "^\\d{4}-\\d{2}-\\d{2}$")
     private LocalDate fechaPago;
 }

src/main/java/io/github/project/openubl/xbuilder/content/models/standard/general/DebitNote.java

@@ -16,12 +16,13 @@
  */
 package io.github.project.openubl.xbuilder.content.models.standard.general;
 
-import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.NoArgsConstructor;
 import lombok.experimental.SuperBuilder;
+import lombok.extern.jackson.Jacksonized;
 
+@Jacksonized
 @Data
 @SuperBuilder
 @NoArgsConstructor

src/main/java/io/github/project/openubl/xbuilder/content/models/standard/general/Detraccion.java

@@ -16,6 +16,7 @@
  */
 package io.github.project.openubl.xbuilder.content.models.standard.general;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import java.math.BigDecimal;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
@@ -36,13 +37,21 @@ public class Detraccion {
     /**
      * Catalog59
      **/
+    @Schema(description = "Catalogo 59", required = true)
     private String medioDePago;
+
+    @Schema(required = true)
     private String cuentaBancaria;
 
     /**
      * Catalog54
      **/
+    @Schema(description = "Catalog 54", required = true)
     private String tipoBienDetraido;
+
+    @Schema(required = true, minimum = "0", maximum = "1", exclusiveMinimum = true)
     private BigDecimal porcentaje;
+
+    @Schema(required = true, minimum = "0", exclusiveMinimum = true)
     private BigDecimal monto;
 }