chore: Add operationId to OpenAPI Documentation (#183)

pagopa · Aug 26, 2024 · 8dd7bd2 · 8dd7bd2
1 parent f9fdaa9
commit 8dd7bd2
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 3 deletions.
diff --git a/apps/user-ms/src/main/docs/openapi.json b/apps/user-ms/src/main/docs/openapi.json
@@ -293,6 +293,7 @@
       "get" : {
         "tags" : [ "support", "support-pnpg", "Institution" ],
         "summary" : "The API retrieves user's info including details of roles on products",
+        "operationId" : "getInstitutionUsersUsingGET",
         "parameters" : [ {
           "name" : "institutionId",
           "in" : "path",
@@ -671,6 +672,7 @@
       "get" : {
         "tags" : [ "User", "external-v2", "support" ],
         "summary" : "Retrieves user given userId and optional ProductId",
+        "operationId" : "getUserInfoUsingGET",
         "parameters" : [ {
           "name" : "id",
           "in" : "path",
@@ -854,6 +856,7 @@
       "put" : {
         "tags" : [ "User", "internal-v1" ],
         "summary" : "Update user status with optional filter for institution, product, role and productRole",
+        "operationId" : "updateUserStatusUsingPUT",
         "parameters" : [ {
           "name" : "id",
           "in" : "path",

diff --git a/apps/user-ms/src/main/docs/openapi.yaml b/apps/user-ms/src/main/docs/openapi.yaml
@@ -206,6 +206,7 @@ paths:
       - support-pnpg
       - Institution
       summary: The API retrieves user's info including details of roles on products
+      operationId: getInstitutionUsersUsingGET
       parameters:
       - name: institutionId
         in: path
@@ -464,6 +465,7 @@ paths:
       - external-v2
       - support
       summary: Retrieves user given userId and optional ProductId
+      operationId: getUserInfoUsingGET
       parameters:
       - name: id
         in: path
@@ -590,6 +592,7 @@ paths:
       - internal-v1
       summary: "Update user status with optional filter for institution, product,\
         \ role and productRole"
+      operationId: updateUserStatusUsingPUT
       parameters:
       - name: id
         in: path

diff --git a/apps/user-ms/src/main/java/it/pagopa/selfcare/user/controller/InstitutionController.java b/apps/user-ms/src/main/java/it/pagopa/selfcare/user/controller/InstitutionController.java
@@ -34,7 +34,7 @@ public class InstitutionController {
 
     private final UserService userService;
 
-    @Operation(summary = "The API retrieves user's info including details of roles on products")
+    @Operation(summary = "The API retrieves user's info including details of roles on products", operationId = "getInstitutionUsersUsingGET")
     @APIResponses(value = {
             @APIResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = UserProductResponse.class, type = SchemaType.ARRAY), mediaType = "application/json")),
             @APIResponse(responseCode = "400", description = "Bad Request", content = @Content(schema = @Schema(implementation = Problem.class), mediaType = "application/problem+json")),

diff --git a/apps/user-ms/src/main/java/it/pagopa/selfcare/user/controller/UserController.java b/apps/user-ms/src/main/java/it/pagopa/selfcare/user/controller/UserController.java
@@ -72,7 +72,7 @@ public Uni<List<String>> getUsersEmailByInstitutionAndProduct(@NotNull @QueryPar
      * @param productId     String
      * @return A uni&amp;lt;userresponse&amp;gt;
      */
-    @Operation(summary = "Retrieves user given userId and optional ProductId")
+    @Operation(summary = "Retrieves user given userId and optional ProductId" , operationId = "getUserInfoUsingGET")
     @APIResponses(value = {
             @APIResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = UserResponse.class), mediaType = "application/json")),
             @APIResponse(responseCode = "400", description = "Bad Request", content = @Content(schema = @Schema(implementation = Problem.class), mediaType = "application/problem+json")),
@@ -161,7 +161,7 @@ public Uni<Void> deleteProducts(@PathParam(value = "userId") String userId,
      * @param status        OnboardedProductState
      * @return A uni&lt;response&gt;
      */
-    @Operation(summary = "Update user status with optional filter for institution, product, role and productRole")
+    @Operation(summary = "Update user status with optional filter for institution, product, role and productRole", operationId = "updateUserStatusUsingPUT")
     @APIResponses(value = {
             @APIResponse(responseCode = "204", description = "No Content"),
             @APIResponse(responseCode = "400", description = "Bad Request", content = @Content(schema = @Schema(implementation = Problem.class), mediaType = "application/problem+json")),