review swagger properties

fiap-8soat-tc-one · Aug 10, 2024 · 07ce50c · 07ce50c
1 parent bc50325
commit 07ce50c
Show file tree

Hide file tree

Showing 11 changed files with 100 additions and 24 deletions.
diff --git a/...in/java/com/fiap/tc/adapters/driver/presentation/requests/DeleteProductImagesRequest.java b/...in/java/com/fiap/tc/adapters/driver/presentation/requests/DeleteProductImagesRequest.java
@@ -1,5 +1,6 @@
 package com.fiap.tc.adapters.driver.presentation.requests;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import javax.validation.Valid;
@@ -12,11 +13,22 @@
 public class DeleteProductImagesRequest {
 
     @NotNull
+    @ApiModelProperty(
+            value = "Product Id",
+            required = true,
+            example = "7ba2a960-2354-466f-8868-6ad713742407",
+            dataType = "UUID"
+    )
     private UUID idProduct;
 
     @NotNull
     @Size(min = 1)
     @Valid
+    @ApiModelProperty(
+            value = "Product Images ids to be deleted",
+            required = true,
+            dataType = "List<UUID>"
+    )
     private List<UUID> images;
 
 }
diff --git a/src/main/java/com/fiap/tc/adapters/driver/presentation/requests/OrderPaymentRequest.java b/src/main/java/com/fiap/tc/adapters/driver/presentation/requests/OrderPaymentRequest.java
@@ -17,6 +17,7 @@ public class OrderPaymentRequest {
     @NotNull
     @ApiModelProperty(
             value = "Transaction Number",
+            required = true,
             example = "7ba2a960-2354-466f-8868-6ad713742407",
             dataType = "String"
     )
@@ -25,6 +26,7 @@ public class OrderPaymentRequest {
     @NotNull
     @ApiModelProperty(
             value = "Transaction Message Result - Order Id",
+            required = true,
             example = "transaction successfully",
             dataType = "String"
     )

diff --git a/src/main/java/com/fiap/tc/adapters/driver/presentation/requests/OrderRequest.java b/src/main/java/com/fiap/tc/adapters/driver/presentation/requests/OrderRequest.java
@@ -1,5 +1,6 @@
 package com.fiap.tc.adapters.driver.presentation.requests;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import javax.validation.Valid;
@@ -10,10 +11,21 @@
 
 @Data
 public class OrderRequest {
+
     @NotNull
     @NotEmpty
     @Valid
+    @ApiModelProperty(
+            value = "Order items request",
+            required = true,
+            dataType = "List<OrderItemRequest>"
+    )
     private List<OrderItemRequest> orderItems;
 
+    @ApiModelProperty(
+            value = "Customer Id",
+            example = "7ba2a960-2354-466f-8868-6ad713742407",
+            dataType = "UUID"
+    )
     private UUID idCustomer;
 }
diff --git a/src/main/java/com/fiap/tc/adapters/driver/presentation/requests/OrderStatusRequest.java b/src/main/java/com/fiap/tc/adapters/driver/presentation/requests/OrderStatusRequest.java
@@ -1,15 +1,31 @@
 package com.fiap.tc.adapters.driver.presentation.requests;
 
 import com.fiap.tc.core.domain.enums.OrderStatus;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import javax.validation.constraints.NotNull;
 import java.util.UUID;
 
 @Data
 public class OrderStatusRequest {
+
     @NotNull
+    @ApiModelProperty(
+            value = "Order Id",
+            example = "7ba2a960-2354-466f-8868-6ad713742407",
+            dataType = "UUID",
+            required = true
+    )
     private UUID id;
+
     @NotNull
+    @ApiModelProperty(
+            value = "Order status",
+            example = "READY",
+            dataType = "String",
+            allowableValues = "RECEIVED, PENDING, PREPARING, READY, FINISHED, CANCELED",
+            required = true
+    )
     private OrderStatus status;
 }
diff --git a/src/main/java/com/fiap/tc/adapters/driver/presentation/requests/ProductRequest.java b/src/main/java/com/fiap/tc/adapters/driver/presentation/requests/ProductRequest.java
@@ -16,7 +16,8 @@ public class ProductRequest {
     @ApiModelProperty(
             value = "Category Id",
             example = "7ba2a960-2354-466f-8868-6ad713742407",
-            dataType = "UUID"
+            dataType = "UUID",
+            required = true
     )
     private UUID idCategory;
 
@@ -44,7 +45,8 @@ public class ProductRequest {
     @ApiModelProperty(
             value = "Product price",
             example = "20.55",
-            dataType = "BigDecimal"
+            dataType = "BigDecimal",
+            required = true
     )
     private BigDecimal price;
 

diff --git a/.../java/com/fiap/tc/adapters/driver/presentation/requests/RegisterProductImagesRequest.java b/.../java/com/fiap/tc/adapters/driver/presentation/requests/RegisterProductImagesRequest.java
@@ -1,5 +1,6 @@
 package com.fiap.tc.adapters.driver.presentation.requests;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import javax.validation.Valid;
@@ -13,12 +14,23 @@
 public class RegisterProductImagesRequest {
 
     @NotNull
+    @ApiModelProperty(
+            value = "Product Id",
+            example = "7ba2a960-2354-466f-8868-6ad713742407",
+            dataType = "UUID",
+            required = true
+    )
     private UUID idProduct;
 
     @NotNull
     @Size(min = 1, max = 5)
     @NotEmpty
     @Valid
+    @ApiModelProperty(
+            value = "List of Product Images to be uploaded",
+            required = true,
+            dataType = "List<ProductImageRequest>"
+    )
     private List<ProductImageRequest> images;
 
 }
diff --git a/...main/java/com/fiap/tc/adapters/driver/presentation/requests/UpdateProductNameRequest.java b/...main/java/com/fiap/tc/adapters/driver/presentation/requests/UpdateProductNameRequest.java
diff --git a/src/main/java/com/fiap/tc/adapters/driver/presentation/response/CategoryResponse.java b/src/main/java/com/fiap/tc/adapters/driver/presentation/response/CategoryResponse.java
@@ -21,7 +21,6 @@ public class CategoryResponse {
     @Size(max = 255, message = "Invalid category name")
     @ApiModelProperty(
             value = "Category name",
-            required = true,
             example = "lanche",
             dataType = "String"
     )
@@ -31,7 +30,6 @@ public class CategoryResponse {
     @Size(max = 255, message = "Invalid category description")
     @ApiModelProperty(
             value = "Category description",
-            required = true,
             example = "categoria de lanche",
             dataType = "String"
     )

diff --git a/src/main/java/com/fiap/tc/adapters/driver/presentation/response/CustomerResponse.java b/src/main/java/com/fiap/tc/adapters/driver/presentation/response/CustomerResponse.java
@@ -24,15 +24,13 @@ public class CustomerResponse {
 
     @ApiModelProperty(
             value = "Customer name",
-            required = true,
             example = "Lucas Silva e Silva",
             dataType = "String"
     )
     private String name;
 
     @ApiModelProperty(
             value = "Customer E-mail",
-            required = true,
             example = "lucas.silva@gmail.com",
             dataType = "String"
     )

diff --git a/src/main/java/com/fiap/tc/adapters/driver/presentation/response/OrderListResponse.java b/src/main/java/com/fiap/tc/adapters/driver/presentation/response/OrderListResponse.java
@@ -17,15 +17,14 @@ public class OrderListResponse {
     private UUID id;
 
     @ApiModelProperty(
-            value = "Order Number",
-            example = "EfhxLZ",
+            value = "Order number to customer follow up",
+            example = "ed6l",
             dataType = "String"
     )
     private String orderNumber;
 
     @ApiModelProperty(
             value = "Order status",
-            required = true,
             example = "READY",
             dataType = "enum"
 
@@ -34,7 +33,6 @@ public class OrderListResponse {
 
     @ApiModelProperty(
             value = "Order wait time in minutes",
-            required = true,
             example = "10",
             dataType = "Optional<Integer>"
     )

diff --git a/src/main/java/com/fiap/tc/adapters/driver/presentation/response/OrderResponse.java b/src/main/java/com/fiap/tc/adapters/driver/presentation/response/OrderResponse.java
@@ -3,6 +3,7 @@
 import com.fiap.tc.adapters.driver.presentation.dtos.OrderHistoricDto;
 import com.fiap.tc.adapters.driver.presentation.dtos.OrderItemDto;
 import com.fiap.tc.core.domain.enums.OrderStatus;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Data;
@@ -19,12 +20,51 @@
 @NoArgsConstructor
 public class OrderResponse {
 
+    @ApiModelProperty(
+            value = "Order Id",
+            example = "7ba2a960-2354-466f-8868-6ad713742407",
+            dataType = "UUID"
+    )
     private UUID id;
+
+    @ApiModelProperty(
+            value = "Order number to customer follow up",
+            example = "ed6l",
+            dataType = "String"
+    )
     private String orderNumber;
+
+    @ApiModelProperty(
+            value = "Order total amount",
+            example = "75.55",
+            dataType = "BigDecimal"
+    )
     private BigDecimal total;
+
+    @ApiModelProperty(
+            value = "Order status",
+            example = "RECEIVED",
+            dataType = "String",
+            allowableValues = "RECEIVED, PENDING, PREPARING, READY, FINISHED, CANCELED"
+    )
     private OrderStatus status;
+
+    @ApiModelProperty(
+            value = "Order items",
+            dataType = "List<OrderItemDto>"
+    )
     private List<OrderItemDto> items;
+
+    @ApiModelProperty(
+            value = "Order Status historic transitions",
+            dataType = "List<OrderHistoricDto>"
+    )
     private List<OrderHistoricDto> orderHistoric;
+
+    @ApiModelProperty(
+            value = "Order payment link qrcode base64 encoded",
+            dataType = "String"
+    )
     private String paymentLink;