chore: Set custom operationId for OnboardingController (#498)

pagopa · Sep 20, 2024 · a2b3ff1 · a2b3ff1
1 parent ba52751
commit a2b3ff1
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 9 deletions.
diff --git a/apps/onboarding-ms/src/main/docs/openapi.json b/apps/onboarding-ms/src/main/docs/openapi.json
@@ -1020,7 +1020,7 @@
         "tags" : [ "internal-v1" ],
         "summary" : "Complete onboarding by verifying and uploading contract, then trigger async activities.",
         "description" : "Perform complete operation of an onboarding request receiving onboarding id and contract signed by the institution.It checks the contract's signature and upload the contract on an azure storageAt the end, function triggers async activities related to complete onboarding that consist of create the institution, activate the onboarding and sending data to notification queue.",
-        "operationId" : "complete",
+        "operationId" : "completeOnboardingUsingPUT",
         "parameters" : [ {
           "name" : "onboardingId",
           "in" : "path",
@@ -1118,7 +1118,7 @@
         "tags" : [ "support", "internal-v1", "Onboarding" ],
         "summary" : "Complete onboarding without verifying contract signature.",
         "description" : "Perform complete operation of an onboarding request as /complete but without signature verification of the contract",
-        "operationId" : "consume",
+        "operationId" : "completeOnboardingTokenConsume",
         "parameters" : [ {
           "name" : "onboardingId",
           "in" : "path",
@@ -1246,7 +1246,7 @@
         "tags" : [ "support", "Onboarding" ],
         "summary" : "Update onboarding request with new values.",
         "description" : "Update onboarding request receiving onboarding id.Function can change some values.",
-        "operationId" : "update",
+        "operationId" : "updateOnboardiUsingPUT",
         "parameters" : [ {
           "name" : "onboardingId",
           "in" : "path",

diff --git a/apps/onboarding-ms/src/main/docs/openapi.yaml b/apps/onboarding-ms/src/main/docs/openapi.yaml
@@ -746,7 +746,7 @@ paths:
         \ triggers async activities related to complete onboarding that consist of\
         \ create the institution, activate the onboarding and sending data to notification\
         \ queue."
-      operationId: complete
+      operationId: completeOnboardingUsingPUT
       parameters:
       - name: onboardingId
         in: path
@@ -825,7 +825,7 @@ paths:
       summary: Complete onboarding without verifying contract signature.
       description: Perform complete operation of an onboarding request as /complete
         but without signature verification of the contract
-      operationId: consume
+      operationId: completeOnboardingTokenConsume
       parameters:
       - name: onboardingId
         in: path
@@ -921,7 +921,7 @@ paths:
       summary: Update onboarding request with new values.
       description: Update onboarding request receiving onboarding id.Function can
         change some values.
-      operationId: update
+      operationId: updateOnboardiUsingPUT
       parameters:
       - name: onboardingId
         in: path

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
@@ -230,7 +230,8 @@ private Uni<String> readUserIdFromToken(SecurityContext ctx) {
             description = "Perform complete operation of an onboarding request receiving onboarding id and contract signed by the institution." +
                     "It checks the contract's signature and upload the contract on an azure storage" +
                     "At the end, function triggers async activities related to complete onboarding " +
-                    "that consist of create the institution, activate the onboarding and sending data to notification queue."
+                    "that consist of create the institution, activate the onboarding and sending data to notification queue.",
+            operationId = "completeOnboardingUsingPUT"
     )
     @PUT
     @Path("/{onboardingId}/complete")
@@ -262,7 +263,8 @@ public Uni<Response> completeOnboardingUser(@PathParam(value = "onboardingId") S
 
     @Operation(
             summary = "Complete onboarding without verifying contract signature.",
-            description = "Perform complete operation of an onboarding request as /complete but without signature verification of the contract"
+            description = "Perform complete operation of an onboarding request as /complete but without signature verification of the contract",
+            operationId = "completeOnboardingTokenConsume"
     )
     @PUT
     @Path("/{onboardingId}/consume")
@@ -395,7 +397,8 @@ private Onboarding fillUserId(Onboarding onboarding, String userRequestUid) {
     @Operation(
             summary = "Update onboarding request with new values.",
             description = "Update onboarding request receiving onboarding id." +
-                    "Function can change some values."
+                    "Function can change some values.",
+            operationId = "updateOnboardiUsingPUT"
     )
     @PUT
     @Tag(name = "support")