[SELC-5054] chore: add "support" tags to getUserInfo and getInstituti…

…onUsers (#153)
pagopa · Jun 11, 2024 · af01275 · af01275
1 parent 7d9cb15
commit af01275
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 10 deletions.
diff --git a/apps/user-ms/src/main/docs/openapi.json b/apps/user-ms/src/main/docs/openapi.json
@@ -12,9 +12,13 @@
     "description" : "Auto generated value"
   } ],
   "tags" : [ {
+    "name" : "Institution"
+  }, {
     "name" : "User"
   }, {
     "name" : "external-v2"
+  }, {
+    "name" : "support"
   } ],
   "paths" : {
     "/authorize" : {
@@ -66,7 +70,7 @@
     },
     "/institutions/{institutionId}" : {
       "put" : {
-        "tags" : [ "Institution Controller" ],
+        "tags" : [ "Institution" ],
         "summary" : "The API updates the description in all occurrences of userInstitution, given a certain institutionId.",
         "parameters" : [ {
           "name" : "institutionId",
@@ -106,7 +110,7 @@
     },
     "/institutions/{institutionId}/products/{productId}/createdAt" : {
       "put" : {
-        "tags" : [ "Institution Controller" ],
+        "tags" : [ "Institution" ],
         "summary" : "The API updates user's onboarded product with createdAt passed in input",
         "parameters" : [ {
           "name" : "institutionId",
@@ -161,7 +165,7 @@
     },
     "/institutions/{institutionId}/user-institutions" : {
       "get" : {
-        "tags" : [ "Institution Controller" ],
+        "tags" : [ "Institution" ],
         "summary" : "The API retrieves users with optional filters in input as query params",
         "parameters" : [ {
           "name" : "institutionId",
@@ -241,7 +245,7 @@
     },
     "/institutions/{institutionId}/users" : {
       "get" : {
-        "tags" : [ "Institution Controller" ],
+        "tags" : [ "support", "Institution" ],
         "summary" : "The API retrieves user's info including details of roles on products",
         "parameters" : [ {
           "name" : "institutionId",
@@ -586,7 +590,7 @@
     },
     "/users/{id}" : {
       "get" : {
-        "tags" : [ "User", "external-v2" ],
+        "tags" : [ "User", "external-v2", "support" ],
         "summary" : "Retrieves user given userId and optional ProductId",
         "parameters" : [ {
           "name" : "id",

diff --git a/apps/user-ms/src/main/docs/openapi.yaml b/apps/user-ms/src/main/docs/openapi.yaml
@@ -9,8 +9,10 @@ servers:
 - url: http://0.0.0.0:8080
   description: Auto generated value
 tags:
+- name: Institution
 - name: User
 - name: external-v2
+- name: support
 paths:
   /authorize:
     get:
@@ -47,7 +49,7 @@ paths:
   /institutions/{institutionId}:
     put:
       tags:
-      - Institution Controller
+      - Institution
       summary: "The API updates the description in all occurrences of userInstitution,\
         \ given a certain institutionId."
       parameters:
@@ -75,7 +77,7 @@ paths:
   /institutions/{institutionId}/products/{productId}/createdAt:
     put:
       tags:
-      - Institution Controller
+      - Institution
       summary: The API updates user's onboarded product with createdAt passed in input
       parameters:
       - name: institutionId
@@ -114,7 +116,7 @@ paths:
   /institutions/{institutionId}/user-institutions:
     get:
       tags:
-      - Institution Controller
+      - Institution
       summary: The API retrieves users with optional filters in input as query params
       parameters:
       - name: institutionId
@@ -168,7 +170,8 @@ paths:
   /institutions/{institutionId}/users:
     get:
       tags:
-      - Institution Controller
+      - support
+      - Institution
       summary: The API retrieves user's info including details of roles on products
       parameters:
       - name: institutionId
@@ -406,6 +409,7 @@ paths:
       tags:
       - User
       - external-v2
+      - support
       summary: Retrieves user given userId and optional ProductId
       parameters:
       - name: id

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
@@ -14,13 +14,15 @@
 import lombok.AllArgsConstructor;
 import org.apache.http.HttpStatus;
 import org.eclipse.microprofile.openapi.annotations.Operation;
+import org.eclipse.microprofile.openapi.annotations.tags.Tag;
 
 import javax.validation.constraints.NotNull;
 import java.time.LocalDateTime;
 import java.util.List;
 
 @Authenticated
 @Path("/institutions")
+@Tag(name = "Institution")
 @AllArgsConstructor
 public class InstitutionController {
 
@@ -29,6 +31,8 @@ public class InstitutionController {
     @Operation(summary = "The API retrieves user's info including details of roles on products")
     @GET
     @Path(value = "/{institutionId}/users")
+    @Tag(name = "support")
+    @Tag(name = "Institution")
     @Produces(MediaType.APPLICATION_JSON)
     public Multi<UserProductResponse> getInstitutionUsers(@PathParam(value = "institutionId") String institutionId) {
         return userService.getUserProductsByInstitution(institutionId);

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
@@ -31,7 +31,6 @@
 import org.eclipse.microprofile.openapi.annotations.parameters.RequestBody;
 import org.eclipse.microprofile.openapi.annotations.tags.Tag;
 import org.jboss.resteasy.reactive.ResponseStatus;
-import org.openapi.quarkus.user_registry_json.model.MutableUserFieldsDto;
 
 import java.util.List;
 
@@ -74,6 +73,7 @@ public Uni<List<String>> getUsersEmailByInstitutionAndProduct(@NotNull @QueryPar
     @Produces(MediaType.APPLICATION_JSON)
     @Tag(name = "User")
     @Tag(name = "external-v2")
+    @Tag(name = "support")
     public Uni<UserResponse> getUserInfo(@PathParam(value = "id") String userId,
                                          @QueryParam(value = "institutionId") String institutionId,
                                          @QueryParam(value = "productId") String productId) {