docs: improve swagger docs

Author: g-otn

techchallenge/src/main/java/br/com/grupo63/techchallenge/adapter/in/controller/client/ClientController.java

@@ -26,50 +26,50 @@ public class ClientController extends AbstractController {
     private final IClientUseCase useCase;
 
     @Operation(
-            summary = "Find a client by their national id",
-            description = "Get client data by their national id.")
+            summary = "Recuperar cliente por CPF",
+            description = "Exibe os dados de um cliente a partir de seu CPF")
     @GetMapping("/cpf/{nationalId}")
     public ClientDTO findByNationalId(@PathVariable String nationalId) throws NotFoundException {
         return useCase.getByNationalId(nationalId);
     }
 
     @Operation(
-            tags = "1ª chamada - fluxo principal",
+            tags = "1ª chamada - Fluxo principal - Pedido",
             summary = "Identificação: Identifica um cliente",
-            description = "Registra um cliente com seu CPF")
+            description = "Registra um cliente através de seu CPF")
     @PostMapping("/criar")
     public ResponseEntity<ClientDTO> create(@RequestParam String nationalId) throws NotFoundException {
         ClientDTO clientDTO = new ClientDTO(nationalId);
         return ResponseEntity.ok(useCase.create(clientDTO));
     }
 
     @Operation(
-            summary = "Get a client by it's id",
-            description = "Find a client by their id.")
+            summary = "Recuperar cliente",
+            description = "Exibe os dados de um produto a partir de seu id")
     @GetMapping("/{id}")
     public ResponseEntity<ClientDTO> read(@PathVariable("id") Long id) throws NotFoundException {
         return ResponseEntity.ok(useCase.read(id));
     }
 
     @Operation(
-            summary = "List all clients",
-            description = "List all clients.")
+            summary = "Listar clientes",
+            description = "Lista todos os clientes")
     @GetMapping("/listar")
     public ResponseEntity<List<ClientDTO>> list() {
         return ResponseEntity.ok(useCase.list());
     }
 
     @Operation(
-            summary = "Update a client",
-            description = "Update a client in the database with the DTO data.")
+            summary = "Atualizar cliente",
+            description = "Atualiza um cliente por id com os dados enviados")
     @PutMapping("/{id}")
     public ResponseEntity<ClientDTO> update(@RequestBody ClientDTO dto, @PathVariable("id") Long id) throws NotFoundException {
         return ResponseEntity.ok(useCase.update(dto, id));
     }
 
     @Operation(
-            summary = "Delete a client",
-            description = "Delete a client in the database by their id.")
+            summary = "Excluir cliente",
+            description = "Exclui um cliente por id")
     @DeleteMapping("/{id}")
     public ResponseEntity<DefaultResponseDTO> delete(@PathVariable("id") Long id) throws NotFoundException {
         useCase.delete(id);

techchallenge/src/main/java/br/com/grupo63/techchallenge/adapter/in/controller/order/OrderController.java

@@ -12,6 +12,7 @@
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.tags.Tag;
+import jakarta.validation.Valid;
 import lombok.RequiredArgsConstructor;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
@@ -28,25 +29,25 @@ public class OrderController extends AbstractController {
     private final IOrderUseCase useCase;
 
     @Operation(
-            tags = "5ª chamada - fluxo principal",
-            summary = "Listar pedidos pagos porém não finalizados.",
-            description = "Seria utilizado pelo monitor no restaurante para exibir os pedidos em preparação e prontos")
+            tags = "5ª chamada - Fluxo principal - Acompanhamento e entrega",
+            summary = "Listar pedidos pagos porém não finalizados",
+            description = "Seria utilizado para acompanha os pedido Recebidos, Em preparação e Prontos")
     @GetMapping("/listar-fila")
     public ResponseEntity<List<OrderDTO>> listUnfinishedOrders() {
         return ResponseEntity.ok(useCase.listUnfinishedOrders());
     }
 
     @Operation(
-            tags = "5ª chamada - fluxo principal",
-            summary = "Avançar com o status do pedido.",
+            tags = "5ª chamada - Fluxo principal - Acompanhamento e entrega",
+            summary = "Avança com o status do pedido",
             description = "Após o pedido ser recebido, esse endpoint seria utilizado pelo funcionário para avançar o status do pedido")
     @PostMapping("/avancar-status")
     public AdvanceOrderStatusResponseDTO advanceOrderStatusFromOrderId(@Parameter(description = "Id do pedido.") @RequestParam Long orderId) throws NotFoundException, ValidationException {
         return new AdvanceOrderStatusResponseDTO(useCase.advanceStatus(orderId));
     }
 
     @Operation(
-            tags = "2ª chamada - fluxo principal",
+            tags = "2ª chamada - Fluxo principal - Pedido",
             summary = "Fake checkout: Tela de resumo do pedido",
             description = "Registra um pedido a ser realizado, retorna o valor total")
     @PostMapping("/criar")
@@ -57,33 +58,33 @@ public ResponseEntity<OrderDTO> create(@RequestParam Long clientId,
     }
 
     @Operation(
-            tags = { "3ª chamada - fluxo principal", "5ª chamada - fluxo principal" },
-            summary = "Get a order by it's id",
-            description = "Find a order by their id.")
+            tags = { "3ª chamada - Fluxo principal - Pagamento", "5ª chamada - Fluxo principal - Acompanhamento e entrega" },
+            summary = "Recupera pedido",
+            description = "Exibe os dados de um pedido a partir de seu id")
     @GetMapping("/{id}")
     public ResponseEntity<OrderDTO> read(@PathVariable("id") Long id) throws NotFoundException {
         return ResponseEntity.ok(useCase.read(id));
     }
 
     @Operation(
-            summary = "List all order",
-            description = "List all orders.")
+            summary = "Listar pedidos",
+            description = "Lista todos os pedidos")
     @GetMapping("/listar")
     public ResponseEntity<List<OrderDTO>> list() {
         return ResponseEntity.ok(useCase.list());
     }
 
-    @Operation(
-            summary = "Update an order",
-            description = "Update an order in the database with the DTO data.")
+//    @Operation(
+//            summary = "Atualizar pedido",
+//            description = "Atualiza um pedido por id com os dados enviados")
 //    @PutMapping("/{id}")
-    public ResponseEntity<OrderDTO> update(@RequestBody OrderDTO dto, @PathVariable("id") Long id) throws NotFoundException {
-        return ResponseEntity.ok(useCase.update(dto, id));
-    }
+//    public ResponseEntity<OrderDTO> update(@RequestBody OrderDTO dto, @PathVariable("id") Long id) throws NotFoundException {
+//        return ResponseEntity.ok(useCase.update(dto, id));
+//    }
 
     @Operation(
-            summary = "Delete a client",
-            description = "Delete a client in the database by their id.")
+            summary = "Excluir cliente",
+            description = "Exclui um cliente por id")
     @DeleteMapping("/{id}")
     public ResponseEntity<DefaultResponseDTO> delete(@PathVariable("id") Long id) throws NotFoundException {
         useCase.delete(id);

techchallenge/src/main/java/br/com/grupo63/techchallenge/adapter/in/controller/payment/PaymentController.java

@@ -23,7 +23,7 @@ public class PaymentController extends AbstractController {
     private final IPaymentUseCase useCase;
 
     @Operation(
-            tags = "3ª chamada - fluxo principal",
+            tags = "3ª chamada - Fluxo principal - Pagamento",
             summary = "Fake checkout: Confirma pedido",
             description = "Registra um pedido e o associa a um pedido. Retorna o QRCode gerado via Mercado Pago para exibição ao cliente.")
     @PostMapping("/iniciar")
@@ -35,7 +35,7 @@ public QRCodeResponseDTO startPayment(
     }
 
     @Operation(
-            tags = "4ª chamada - fluxo principal",
+            tags = "4ª chamada - Fluxo principal - Pagamento",
             summary = "Fake checkout: Finalizar pagamento",
             description = "Atualiza o status do pagamento e do pedido. Seria utilizado pelo sistema externo Mercado Pago para simular uma integração de Webhook IPN para notificar o sistema que o pagamento foi concluido.")
     @PostMapping("/finalizar")
@@ -46,7 +46,7 @@ public void confirmPaymentFromOrderId(@Parameter(description = "Id do pedido ass
     }
 
     @Operation(
-            tags = "4ª chamada - fluxo principal",
+            tags = "4ª chamada - Fluxo principal - Pagamento",
             summary = "Recuperar status do pagamento",
             description = "Recupera o status atual do pagamento. Seria utilizado na tela de pagamento do cliente para verificar se o pagamento foi realizado.")
     @GetMapping("/status")

techchallenge/src/main/java/br/com/grupo63/techchallenge/adapter/in/controller/product/ProductController.java

@@ -24,6 +24,17 @@ public class ProductController extends AbstractController {
 
     private final IProductUseCase useCase;
 
+    @Operation(
+            tags = "2ª chamada - Fluxo principal - Pedido",
+            summary = "Listar produtos por categoria",
+            description = "Lista todos os produtos por nome da categoria")
+    @GetMapping("/listar-por-categoria")
+    public ResponseEntity<List<ProductDTO>> listByCategoryName(
+            @Schema(allowableValues = {"Lanche", "Acompanhamento", "Bebida", "Sobremesa"})
+            @RequestParam(value = "categoria") String categoryName) {
+        return ResponseEntity.ok(useCase.listByCategoryName(categoryName));
+    }
+
     @Operation(
             summary = "Criar um produto",
             description = "Cria um produto com nome, preço, estoque inicial e categoria. Possíveis categorias (IDs): " +
@@ -34,45 +45,35 @@ public ResponseEntity<ProductDTO> create(@Valid @RequestBody ProductDTO dto) thr
     }
 
     @Operation(
-            summary = "Get a product by it's id",
-            description = "Find a product by their id.")
+            summary = "Recuperar produto",
+            description = "Exibe os dados de um produto a partir de seu id")
     @GetMapping("/{id}")
     public ResponseEntity<ProductDTO> read(@PathVariable("id") Long id) throws NotFoundException {
         return ResponseEntity.ok(useCase.read(id));
     }
 
     @Operation(
-            summary = "List all products",
-            description = "List all products.")
+            summary = "Listar produtos",
+            description = "Lista todos os produtos")
     @GetMapping("/listar")
     public ResponseEntity<List<ProductDTO>> list() {
         return ResponseEntity.ok(useCase.list());
     }
 
     @Operation(
-            summary = "Update a product",
-            description = "Update a product in the database with the DTO data.")
+            summary = "Atualizar produto",
+            description = "Atualiza um produto por id com os dados enviados")
     @PutMapping("/{id}")
     public ResponseEntity<ProductDTO> update(@RequestBody ProductDTO dto, @PathVariable("id") Long id) throws NotFoundException {
         return ResponseEntity.ok(useCase.update(dto, id));
     }
 
     @Operation(
-            summary = "Delete a product",
-            description = "Delete a product in the database by their id.")
+            summary = "Excluir produto",
+            description = "Exclui um produto por id")
     @DeleteMapping("/{id}")
     public ResponseEntity<DefaultResponseDTO> delete(@PathVariable("id") Long id) throws NotFoundException {
         useCase.delete(id);
         return ResponseEntity.ok().build();
     }
-
-    @Operation(
-            summary = "Listar produtos por categoria",
-            description = "Lista todos os produtos por nome da categoria")
-    @GetMapping("/listar-por-categoria")
-    public ResponseEntity<List<ProductDTO>> listByCategoryName(
-            @Schema(allowableValues = {"Lanche", "Acompanhamento", "Bebida", "Sobremesa"})
-            @RequestParam(value = "categoria") String categoryName) {
-        return ResponseEntity.ok(useCase.listByCategoryName(categoryName));
-    }
 }

techchallenge/src/main/java/br/com/grupo63/techchallenge/core/application/usecase/dto/OrderDTO.java

@@ -6,6 +6,7 @@
 import br.com.grupo63.techchallenge.core.domain.model.order.OrderStatus;
 import br.com.grupo63.techchallenge.core.domain.model.payment.Payment;
 import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.constraints.NotNull;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
@@ -28,6 +29,7 @@ public class OrderDTO extends AbstractUseCaseDomainDTO<Order> {
 
     private ClientDTO client;
 
+    @NotNull
     private List<OrderItemDTO> items = new ArrayList<>();
 
     private PaymentDTO payment;

techchallenge/src/main/java/br/com/grupo63/techchallenge/core/application/usecase/dto/PaymentDTO.java

@@ -24,6 +24,7 @@ public class PaymentDTO extends AbstractUseCaseDomainDTO<Payment> {
     public static PaymentDTO toDto(Payment payment) {
         PaymentDTO paymentDTO = new PaymentDTO();
 
+        paymentDTO.setId(payment.getId());
         paymentDTO.setStatus(payment.getStatus());
         paymentDTO.setMethod(payment.getMethod());
         paymentDTO.setQrData(payment.getQrData());

techchallenge/src/main/java/br/com/grupo63/techchallenge/core/application/usecase/order/OrderUseCase.java

@@ -10,6 +10,7 @@
 import br.com.grupo63.techchallenge.core.domain.model.order.OrderItem;
 import br.com.grupo63.techchallenge.core.domain.model.order.OrderStatus;
 import br.com.grupo63.techchallenge.core.domain.model.payment.PaymentStatus;
+import jakarta.validation.Valid;
 import jakarta.validation.constraints.NotNull;
 import lombok.RequiredArgsConstructor;
 import org.springframework.stereotype.Service;
@@ -63,7 +64,7 @@ public List<OrderDTO> listUnfinishedOrders() {
     }
 
     @Override
-    public OrderDTO create(OrderDTO orderDTO) throws NotFoundException {
+    public OrderDTO create(@Valid OrderDTO orderDTO) throws NotFoundException {
         Order order = new Order();
         orderDTO.fillDomain(order);
 

techchallenge/src/main/java/br/com/grupo63/techchallenge/core/domain/model/order/OrderStatus.java

@@ -4,8 +4,6 @@
 
 @AllArgsConstructor
 public enum OrderStatus {
-    RECEIVED("Recebido"), PREPARING("Em preparação"), READY("Pronto"), FINISHED("Finalizado");
-
-    private final String name;
+    RECEIVED, PREPARING, READY, FINISHED;
 
 }

techchallenge/src/main/java/br/com/grupo63/techchallenge/core/domain/model/payment/PaymentMethod.java

@@ -4,7 +4,6 @@
 
 @AllArgsConstructor
 public enum PaymentMethod {
-    MERCADO_PAGO_QR_CODE("QR Code Mercado Pago");
+    MERCADO_PAGO_QR_CODE
 
-    private String name;
 }

techchallenge/src/main/java/br/com/grupo63/techchallenge/core/domain/model/payment/PaymentStatus.java

@@ -4,7 +4,6 @@
 
 @AllArgsConstructor
 public enum PaymentStatus {
-    PENDING("Pendente"), PAID("Pago");
+    PENDING, PAID;
 
-    private String name;
 }