[SELC-7672] Added support tag to deleteMemberFromUserGroup and deleteMemberFromUserGroups. Improved documentation.

Author: gaetano-miglionico

apps/user-group-ms/src/main/docs/openapi.json

@@ -86,7 +86,7 @@
         }, {
           "name" : "userId",
           "in" : "query",
-          "description" : "Member's unique identifier",
+          "description" : "Member's unique identifier (userId)",
           "required" : false,
           "style" : "form",
           "schema" : {
@@ -234,14 +234,14 @@
     },
     "/v1/user-groups/members/{memberId}" : {
       "delete" : {
-        "tags" : [ "UserGroup" ],
+        "tags" : [ "UserGroup", "support" ],
         "summary" : "deleteMemberFromUserGroups",
-        "description" : "Service to delete a member from a specific UserGroup entity",
+        "description" : "Service to delete a member from every group of a specific product of an institution",
         "operationId" : "deleteMemberFromUserGroupsUsingDELETE",
         "parameters" : [ {
           "name" : "memberId",
           "in" : "path",
-          "description" : "Member's unique identifier",
+          "description" : "Member's unique identifier (userId)",
           "required" : true,
           "style" : "simple",
           "schema" : {
@@ -251,7 +251,7 @@
         }, {
           "name" : "institutionId",
           "in" : "query",
-          "description" : "institutionId",
+          "description" : "Users group's institutionId",
           "required" : true,
           "style" : "form",
           "schema" : {
@@ -260,7 +260,7 @@
         }, {
           "name" : "productId",
           "in" : "query",
-          "description" : "productId",
+          "description" : "Users group's productId",
           "required" : true,
           "style" : "form",
           "schema" : {
@@ -588,7 +588,7 @@
         }, {
           "name" : "memberId",
           "in" : "path",
-          "description" : "Member's unique identifier",
+          "description" : "Member's unique identifier (userId)",
           "required" : true,
           "style" : "simple",
           "schema" : {
@@ -636,7 +636,7 @@
         } ]
       },
       "delete" : {
-        "tags" : [ "UserGroup" ],
+        "tags" : [ "UserGroup", "support" ],
         "summary" : "deleteMemberFromUserGroup",
         "description" : "Service to delete a member from a specific UserGroup entity",
         "operationId" : "deleteMemberFromUserGroupUsingDELETE",
@@ -652,7 +652,7 @@
         }, {
           "name" : "memberId",
           "in" : "path",
-          "description" : "Member's unique identifier",
+          "description" : "Member's unique identifier (userId)",
           "required" : true,
           "style" : "simple",
           "schema" : {

apps/user-group-ms/src/main/java/it/pagopa/selfcare/user_group/controller/UserGroupV1Controller.java

@@ -197,26 +197,28 @@ public Page<UserGroupResource> getUserGroups(@ApiParam("${swagger.user-group.mod
     @DeleteMapping(value = "/{id}/members/{memberId}")
     @ResponseStatus(HttpStatus.NO_CONTENT)
     @ApiOperation(value = "", notes = "${swagger.user-group.groups.api.deleteMember}")
+    @Tag(name = "UserGroup")
+    @Tag(name = "support")
     public void deleteMemberFromUserGroup(@ApiParam("${swagger.user-group.model.id}")
-                                          @PathVariable("id")
-                                                  String userGroupId,
+                                          @PathVariable("id") String userGroupId,
                                           @ApiParam("${swagger.user-group.model.memberId}")
-                                          @PathVariable("memberId")
-                                                  UUID memberId) {
+                                          @PathVariable("memberId") UUID memberId) {
         log.trace("deleteMemberFromUserGroup start");
         log.debug("deleteMemberFromUserGroup userGroupId = {}, memberId = {}", Encode.forJava(userGroupId), memberId);
         groupService.deleteMember(userGroupId, memberId.toString());
         log.trace("deleteMemberFromUserGroup end");
     }
 
-
     @DeleteMapping(value = "/members/{memberId}")
     @ResponseStatus(HttpStatus.NO_CONTENT)
-    @ApiOperation(value = "", notes = "${swagger.user-group.groups.api.deleteMember}")
+    @ApiOperation(value = "", notes = "${swagger.user-group.groups.api.deleteMembers}")
+    @Tag(name = "UserGroup")
+    @Tag(name = "support")
     public void deleteMemberFromUserGroups(@ApiParam("${swagger.user-group.model.memberId}")
-                                           @PathVariable("memberId")
-                                                   UUID memberId,
+                                           @PathVariable("memberId") UUID memberId,
+                                           @ApiParam("${swagger.user-group.model.institutionId}")
                                            @RequestParam(value = "institutionId") String institutionId,
+                                           @ApiParam("${swagger.user-group.model.productId}")
                                            @RequestParam(value = "productId") String productId) {
         log.trace("deleteMemberFromUserGroups start");
         log.debug("deleteMemberFromUserGroups memberId = {}, institutionId = {}, productId = {}", memberId, Encode.forJava(institutionId), Encode.forJava(productId));

apps/user-group-ms/src/main/resources/swagger/swagger_en.properties

@@ -13,6 +13,7 @@ swagger.user-group.groups.api.getUserGroups=Service that allows to get a list of
 swagger.user-group.groups.api.getUserGroup=Service to get a specific UserGroup entity
 swagger.user-group.groups.api.addMember=Service to add a member to a specific UserGroup entity
 swagger.user-group.groups.api.deleteMember=Service to delete a member from a specific UserGroup entity
+swagger.user-group.groups.api.deleteMembers=Service to delete a member from every group of a specific product of an institution
 swagger.user-group.model.id=Users group's unique identifier
 swagger.user-group.model.institutionId=Users group's institutionId
 swagger.user-group.model.productId=Users group's productId
@@ -21,7 +22,7 @@ swagger.user-group.model.description=Users group's description
 swagger.user-group.model.status=Users group's status
 swagger.user-group.model.members=List of all the members of the group
 swagger.user-group.model.pageable=Details for retrieving usergroups based on size and index
-swagger.user-group.model.memberId=Member's unique identifier
+swagger.user-group.model.memberId=Member's unique identifier (userId)
 swagger.user-group.model.createdAt=Date on which the group was created
 swagger.user-group.model.createdBy=User by which the group was created
 swagger.user-group.model.modifiedAt=Date on which the group was modified