chore: Added Auto-generation operationId and Swagger description on e…

…ach endpoint (#494)
pagopa · Sep 20, 2024 · 430a944 · 430a944
1 parent e15e95c
commit 430a944
Show file tree

Hide file tree

Showing 7 changed files with 359 additions and 129 deletions.
diff --git a/apps/onboarding-ms/src/main/docs/openapi.json b/apps/onboarding-ms/src/main/docs/openapi.json
diff --git a/apps/onboarding-ms/src/main/docs/openapi.yaml b/apps/onboarding-ms/src/main/docs/openapi.yaml
diff --git a/...rding-ms/src/main/java/it/pagopa/selfcare/onboarding/controller/AggregatesController.java b/...rding-ms/src/main/java/it/pagopa/selfcare/onboarding/controller/AggregatesController.java
@@ -25,7 +25,10 @@ public class AggregatesController {
     @Inject
     AggregatesService aggregatesService;
 
-    @Operation(summary = "Validate the data related to the aggregated entities present in a CSV file")
+    @Operation(
+            summary = "Validate the data related to the aggregated entities present in a CSV file",
+            description = "Validates aggregated entity data specific to the PROD-IO environment by processing the provided CSV file. This ensures that all entries meet the required criteria before further processing."
+    )
     @POST
     @Path("/verification/prod-io")
     @Produces(MediaType.APPLICATION_JSON)
@@ -35,7 +38,10 @@ public Uni<VerifyAggregateResponse> verifyAppIoAggregatesCsv(@NotNull @RestForm(
         return aggregatesService.validateAppIoAggregatesCsv(file);
     }
 
-    @Operation(summary = "Validate the data related to the aggregated entities present in a CSV file")
+    @Operation(
+            summary = "Validate the data related to the aggregated entities present in a CSV file",
+            description = "Validates aggregated entity data specific to the PROD-PN environment by processing the provided CSV file. This ensures that all entries meet the required criteria before further processing."
+    )
     @POST
     @Path("/verification/prod-pn")
     @Produces(MediaType.APPLICATION_JSON)
@@ -45,7 +51,10 @@ public Uni<VerifyAggregateSendResponse> verifySendAggregatesCsv(@NotNull @RestFo
         return aggregatesService.validateSendAggregatesCsv(file);
     }
 
-    @Operation(summary = "Validate the data related to the aggregated entities present in a CSV file")
+    @Operation(
+            summary = "Validate the data related to the aggregated entities present in a CSV file",
+            description = "Validates aggregated entity data specific to the PROD-Pagopa environment by processing the provided CSV file. This ensures that all entries meet the required criteria before further processing."
+    )
     @POST
     @Path("/verification/prod-pagopa")
     @Produces(MediaType.APPLICATION_JSON)

diff --git a/...ing-ms/src/main/java/it/pagopa/selfcare/onboarding/controller/NotificationController.java b/...ing-ms/src/main/java/it/pagopa/selfcare/onboarding/controller/NotificationController.java
@@ -18,7 +18,10 @@
 @AllArgsConstructor
 public class NotificationController {
     private final NotificationService notificationService;
-    @Operation(summary = "Resend onboarding notifications for onboarding which are retrieved given a set of filters")
+    @Operation(
+            summary = "Resend onboarding notifications for onboarding which are retrieved given a set of filters",
+            description = "Resends notifications for all onboarding records that match the specified filter criteria. This allows administrators to trigger notification processes again for specific onboardings based on parameters such as product ID, tax code, institution ID, and more."
+    )
     @POST
     @Produces(MediaType.APPLICATION_JSON)
     @Path("/resend")

diff --git a/...rding-ms/src/main/java/it/pagopa/selfcare/onboarding/controller/OnboardingController.java b/...rding-ms/src/main/java/it/pagopa/selfcare/onboarding/controller/OnboardingController.java
diff --git a/...onboarding-ms/src/main/java/it/pagopa/selfcare/onboarding/controller/TokenController.java b/...onboarding-ms/src/main/java/it/pagopa/selfcare/onboarding/controller/TokenController.java
@@ -32,7 +32,10 @@ public class TokenController {
      * * Code: 404, Message: Token not found, DataType: Problem
      */
 
-    @Operation(summary = "Retrieves the token for a given onboarding")
+    @Operation(
+            summary = "Retrieves the token for a given onboarding",
+            description = "Fetches a list of tokens associated with the specified onboarding ID."
+    )
     @GET
     public Uni<List<TokenResponse>> getToken(@QueryParam(value = "onboardingId") String onboardingId){
         return tokenService.getToken(onboardingId)
@@ -41,7 +44,10 @@ public Uni<List<TokenResponse>> getToken(@QueryParam(value = "onboardingId") Str
                         .toList());
     }
 
-    @Operation(summary = "Retrieve contract not signed for a given onboarding")
+    @Operation(
+            summary = "Retrieve contract not signed for a given onboarding",
+            description = "Downloads the unsigned contract file associated with the specified onboarding ID."
+    )
     @GET
     @Produces(MediaType.APPLICATION_OCTET_STREAM)
     @Path("/{onboardingId}/contract")

diff --git a/apps/onboarding-ms/src/main/resources/application.properties b/apps/onboarding-ms/src/main/resources/application.properties
@@ -77,6 +77,7 @@ quarkus.rest-client."org.openapi.quarkus.party_registry_proxy_json.api.Instituti
 quarkus.rest-client."org.openapi.quarkus.core_json.api.InstitutionApi".url=${MS_CORE_URL:http://localhost:8080}
 quarkus.rest-client."org.openapi.quarkus.core_json.api.InstitutionApi".read-timeout=60000
 
+mp.openapi.extensions.smallrye.operationIdStrategy=METHOD
 
 ## AZURE STORAGE ##