Fix swagger tags in controllers 76/122976/1
authorRam Krishna Verma <ram_krishna.verma@bell.ca>
Thu, 29 Jul 2021 20:42:07 +0000 (16:42 -0400)
committerRam Krishna Verma <ram_krishna.verma@bell.ca>
Thu, 29 Jul 2021 20:42:13 +0000 (16:42 -0400)
Fixing the swagger tags in controllers to match with documents.

Issue-ID: POLICY-3340
Change-Id: Ib30029cc4efa287348f5869f036b30cbab3db079
Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
main/src/main/java/org/onap/policy/pap/main/rest/PdpGroupCreateOrUpdateControllerV1.java
main/src/main/java/org/onap/policy/pap/main/rest/PdpGroupDeleteControllerV1.java
main/src/main/java/org/onap/policy/pap/main/rest/PdpGroupDeployControllerV1.java
main/src/main/java/org/onap/policy/pap/main/rest/PdpGroupQueryControllerV1.java
main/src/main/java/org/onap/policy/pap/main/rest/PdpGroupStateChangeControllerV1.java
main/src/main/java/org/onap/policy/pap/main/rest/PolicyAuditControllerV1.java
main/src/main/java/org/onap/policy/pap/main/rest/PolicyComponentsHealthCheckControllerV1.java
main/src/main/java/org/onap/policy/pap/main/rest/PolicyStatusControllerV1.java
main/src/main/java/org/onap/policy/pap/main/rest/StatisticsRestControllerV1.java

index 3dcb197..505f7fe 100644 (file)
@@ -63,7 +63,7 @@ public class PdpGroupCreateOrUpdateControllerV1 extends PapRestControllerV1 {
     @ApiOperation(value = "Create or update PDP Groups",
         notes = "Create or update one or more PDP Groups, returning optional error details",
         response = PdpGroupUpdateResponse.class,
-        tags = {"Policy Administration (PAP) API"},
+        tags = {"PdpGroup Create/Update"},
         authorizations = @Authorization(value = AUTHORIZATION_TYPE),
         responseHeaders = {
             @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
index 276408f..1291676 100644 (file)
@@ -66,7 +66,7 @@ public class PdpGroupDeleteControllerV1 extends PapRestControllerV1 {
     @ApiOperation(value = "Delete PDP Group",
         notes = "Deletes a PDP Group, returning optional error details",
         response = PdpGroupDeleteResponse.class,
-        tags = {"Policy Administration (PAP) API"},
+        tags = {"PdpGroup Delete"},
         authorizations = @Authorization(value = AUTHORIZATION_TYPE),
         responseHeaders = {
             @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
@@ -110,7 +110,7 @@ public class PdpGroupDeleteControllerV1 extends PapRestControllerV1 {
     @ApiOperation(value = "Undeploy a PDP Policy from PDPs",
         notes = "Undeploys the latest version of a policy from the PDPs, returning optional error details",
         response = PdpGroupDeployResponse.class,
-        tags = {"Policy Administration (PAP) API"},
+        tags = {"PdpGroup Delete"},
         authorizations = @Authorization(value = AUTHORIZATION_TYPE),
         responseHeaders = {
             @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
@@ -156,7 +156,7 @@ public class PdpGroupDeleteControllerV1 extends PapRestControllerV1 {
     @ApiOperation(value = "Undeploy version of a PDP Policy from PDPs",
         notes = "Undeploys a specific version of a policy from the PDPs, returning optional error details",
         response = PdpGroupDeployResponse.class,
-        tags = {"Policy Administration (PAP) API"},
+        tags = {"PdpGroup Delete"},
         authorizations = @Authorization(value = AUTHORIZATION_TYPE),
         responseHeaders = {
             @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
index 7357771..86d730f 100644 (file)
@@ -71,7 +71,7 @@ public class PdpGroupDeployControllerV1 extends PapRestControllerV1 {
     @ApiOperation(value = "Updates policy deployments within specific PDP groups",
         notes = "Updates policy deployments within specific PDP groups, returning optional error details",
         response = PdpGroupDeployResponse.class,
-        tags = {"Policy Administration (PAP) API"},
+        tags = {"Deployments Update"},
         authorizations = @Authorization(value = AUTHORIZATION_TYPE),
         responseHeaders = {
             @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
@@ -116,7 +116,7 @@ public class PdpGroupDeployControllerV1 extends PapRestControllerV1 {
     @ApiOperation(value = "Deploy or update PDP Policies",
         notes = "Deploys or updates PDP Policies, returning optional error details",
         response = PdpGroupDeployResponse.class,
-        tags = {"Policy Administration (PAP) API"},
+        tags = {"Deployments Update"},
         authorizations = @Authorization(value = AUTHORIZATION_TYPE),
         responseHeaders = {
             @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
index 1edf229..c28b91e 100644 (file)
@@ -64,7 +64,7 @@ public class PdpGroupQueryControllerV1 extends PapRestControllerV1 {
     @ApiOperation(value = "Query details of all PDP groups",
         notes = "Queries details of all PDP groups, returning all group details",
         response = PdpGroups.class,
-        tags = {"Policy Administration (PAP) API"},
+        tags = {"PdpGroup Query"},
         authorizations = @Authorization(value = AUTHORIZATION_TYPE),
         responseHeaders = {
             @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
index 8610c52..9435296 100644 (file)
@@ -69,7 +69,7 @@ public class PdpGroupStateChangeControllerV1 extends PapRestControllerV1 {
     @ApiOperation(value = "Change state of a PDP Group",
         notes = "Changes state of PDP Group, returning optional error details",
         response = PdpGroupStateChangeResponse.class,
-        tags = {"Policy Administration (PAP) API"},
+        tags = {"PdpGroup State Change"},
         authorizations = @Authorization(value = AUTHORIZATION_TYPE),
         responseHeaders = {
             @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
index 7848cf3..ccbc946 100644 (file)
@@ -70,7 +70,7 @@ public class PolicyAuditControllerV1 extends PapRestControllerV1 {
         notes = "Queries audit information for all the policies, "
             + "returning audit information for all the policies in the database",
         responseContainer = "List", response = PolicyAudit.class,
-        tags = {"Policy Administration (PAP) API"},
+        tags = {"Policy Audit"},
         authorizations = @Authorization(value = AUTHORIZATION_TYPE),
         responseHeaders = {
             @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
@@ -136,7 +136,7 @@ public class PolicyAuditControllerV1 extends PapRestControllerV1 {
         notes = "Queries audit information for all the policies in a PdpGroup, "
             + "returning audit information for all the policies belonging to the PdpGroup",
         responseContainer = "List", response = PolicyAudit.class,
-        tags = {"Policy Administration (PAP) API"},
+        tags = {"Policy Audit"},
         authorizations = @Authorization(value = AUTHORIZATION_TYPE),
         responseHeaders = {
             @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
@@ -205,7 +205,7 @@ public class PolicyAuditControllerV1 extends PapRestControllerV1 {
         notes = "Queries audit information for a specific version of a policy in a PdpGroup,"
             + " returning audit information for the policy belonging to the PdpGroup",
         response = PolicyAudit.class,
-        tags = {"Policy Administration (PAP) API"},
+        tags = {"Policy Audit"},
         authorizations = @Authorization(value = AUTHORIZATION_TYPE),
         responseHeaders = {
             @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
@@ -276,7 +276,7 @@ public class PolicyAuditControllerV1 extends PapRestControllerV1 {
         notes = "Queries audit information for a specific version of a policy,"
             + " returning audit information for the policy",
         response = PolicyAudit.class,
-        tags = {"Policy Administration (PAP) API"},
+        tags = {"Policy Audit"},
         authorizations = @Authorization(value = AUTHORIZATION_TYPE),
         responseHeaders = {
             @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
index 691e0dc..4e9a827 100644 (file)
@@ -70,7 +70,7 @@ public class PolicyComponentsHealthCheckControllerV1 extends PapRestControllerV1
     @ApiOperation(value = "Returns health status of all policy components, including PAP, API, Distribution, and PDPs",
         notes = "Queries health status of all policy components, returning all policy components health status",
         response = Map.class,
-        tags = {"Policy Administration (PAP) API"},
+        tags = {"Consolidated Healthcheck"},
         authorizations = @Authorization(value = AUTHORIZATION_TYPE),
         responseHeaders = {
             @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
index c46845a..7333432 100644 (file)
@@ -74,7 +74,7 @@ public class PolicyStatusControllerV1 extends PapRestControllerV1 {
     @ApiOperation(value = "Queries status of all deployed policies",
         notes = "Queries status of all deployed policies, returning success and failure counts of the PDPs",
         responseContainer = "List", response = PolicyStatus.class,
-        tags = {"Policy Administration (PAP) API"},
+        tags = {"Policy Deployment Status"},
         authorizations = @Authorization(value = AUTHORIZATION_TYPE),
         responseHeaders = {
             @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
@@ -137,7 +137,7 @@ public class PolicyStatusControllerV1 extends PapRestControllerV1 {
     @ApiOperation(value = "Queries status of specific deployed policies",
         notes = "Queries status of specific deployed policies, returning success and failure counts of the PDPs",
         responseContainer = "List", response = PolicyStatus.class,
-        tags = {"Policy Administration (PAP) API"},
+        tags = {"Policy Deployment Status"},
         authorizations = @Authorization(value = AUTHORIZATION_TYPE),
         responseHeaders = {
             @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
@@ -196,7 +196,7 @@ public class PolicyStatusControllerV1 extends PapRestControllerV1 {
     @ApiOperation(value = "Queries status of a specific deployed policy",
         notes = "Queries status of a specific deployed policy, returning success and failure counts of the PDPs",
         response = PolicyStatus.class,
-        tags = {"Policy Administration (PAP) API"},
+        tags = {"Policy Deployment Status"},
         authorizations = @Authorization(value = AUTHORIZATION_TYPE),
         responseHeaders = {
             @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
@@ -256,7 +256,7 @@ public class PolicyStatusControllerV1 extends PapRestControllerV1 {
         notes = "Queries status of policies in all PdpGroups, "
             + "returning status of policies in all the PDPs belonging to all PdpGroups",
         responseContainer = "List", response = PdpPolicyStatus.class,
-        tags = {"Policy Administration (PAP) API"},
+        tags = {"Policy Status"},
         authorizations = @Authorization(value = AUTHORIZATION_TYPE),
         responseHeaders = {
             @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
@@ -311,7 +311,7 @@ public class PolicyStatusControllerV1 extends PapRestControllerV1 {
         notes = "Queries status of policies in a specific PdpGroup, "
             + "returning status of policies in all the PDPs belonging to the PdpGroup",
         responseContainer = "List", response = PdpPolicyStatus.class,
-        tags = {"Policy Administration (PAP) API"},
+        tags = {"Policy Status"},
         authorizations = @Authorization(value = AUTHORIZATION_TYPE),
         responseHeaders = {
             @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
index b08964b..fb64b05 100644 (file)
@@ -84,7 +84,7 @@ public class StatisticsRestControllerV1 extends PapRestControllerV1 {
     @Path("pdps/statistics")
     @ApiOperation(value = "Fetch  statistics for all PDP Groups and subgroups in the system",
             notes = "Returns for all PDP Groups and subgroups statistics of the Policy Administration component",
-            response = Map.class, tags = {"Policy Administration (PAP) API"},
+            response = Map.class, tags = {"PDP Statistics"},
                     authorizations = @Authorization(value = AUTHORIZATION_TYPE),
                     responseHeaders = {
                         @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
@@ -134,7 +134,7 @@ public class StatisticsRestControllerV1 extends PapRestControllerV1 {
     @Path("pdps/statistics/{group}")
     @ApiOperation(value = "Fetch current statistics for given PDP Group",
             notes = "Returns statistics for given PDP Group of the Policy Administration component",
-            response = Map.class, tags = {"Policy Administration (PAP) API"},
+            response = Map.class, tags = {"PDP Statistics"},
             authorizations = @Authorization(value = AUTHORIZATION_TYPE),
             responseHeaders = {
                 @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
@@ -185,7 +185,7 @@ public class StatisticsRestControllerV1 extends PapRestControllerV1 {
     @Path("pdps/statistics/{group}/{type}")
     @ApiOperation(value = "Fetch statistics for the specified subgroup",
             notes = "Returns  statistics for the specified subgroup of the Policy Administration component",
-            response = Map.class, tags = {"Policy Administration (PAP) API"},
+            response = Map.class, tags = {"PDP Statistics"},
             authorizations = @Authorization(value = AUTHORIZATION_TYPE),
             responseHeaders = {
                 @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
@@ -240,7 +240,7 @@ public class StatisticsRestControllerV1 extends PapRestControllerV1 {
     @ApiOperation(value = "Fetch statistics for the specified pdp",
             notes = "Returns  statistics for the specified pdp of the Policy Administration component",
             response = Map.class,
-            tags = {"Policy Administration (PAP) API"},
+            tags = {"PDP Statistics"},
             authorizations = @Authorization(value = AUTHORIZATION_TYPE),
             responseHeaders = {
                 @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,