From 68e19603b7680677767b7ce37e3dea21e10cb81a Mon Sep 17 00:00:00 2001 From: Ram Krishna Verma Date: Thu, 29 Jul 2021 16:42:07 -0400 Subject: Fix swagger tags in controllers Fixing the swagger tags in controllers to match with documents. Issue-ID: POLICY-3340 Change-Id: Ib30029cc4efa287348f5869f036b30cbab3db079 Signed-off-by: Ram Krishna Verma --- .../pap/main/rest/PdpGroupCreateOrUpdateControllerV1.java | 2 +- .../onap/policy/pap/main/rest/PdpGroupDeleteControllerV1.java | 6 +++--- .../onap/policy/pap/main/rest/PdpGroupDeployControllerV1.java | 4 ++-- .../onap/policy/pap/main/rest/PdpGroupQueryControllerV1.java | 2 +- .../policy/pap/main/rest/PdpGroupStateChangeControllerV1.java | 2 +- .../org/onap/policy/pap/main/rest/PolicyAuditControllerV1.java | 8 ++++---- .../pap/main/rest/PolicyComponentsHealthCheckControllerV1.java | 2 +- .../onap/policy/pap/main/rest/PolicyStatusControllerV1.java | 10 +++++----- .../onap/policy/pap/main/rest/StatisticsRestControllerV1.java | 8 ++++---- 9 files changed, 22 insertions(+), 22 deletions(-) diff --git a/main/src/main/java/org/onap/policy/pap/main/rest/PdpGroupCreateOrUpdateControllerV1.java b/main/src/main/java/org/onap/policy/pap/main/rest/PdpGroupCreateOrUpdateControllerV1.java index 3dcb197e..505f7fee 100644 --- a/main/src/main/java/org/onap/policy/pap/main/rest/PdpGroupCreateOrUpdateControllerV1.java +++ b/main/src/main/java/org/onap/policy/pap/main/rest/PdpGroupCreateOrUpdateControllerV1.java @@ -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, diff --git a/main/src/main/java/org/onap/policy/pap/main/rest/PdpGroupDeleteControllerV1.java b/main/src/main/java/org/onap/policy/pap/main/rest/PdpGroupDeleteControllerV1.java index 276408f5..12916769 100644 --- a/main/src/main/java/org/onap/policy/pap/main/rest/PdpGroupDeleteControllerV1.java +++ b/main/src/main/java/org/onap/policy/pap/main/rest/PdpGroupDeleteControllerV1.java @@ -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, diff --git a/main/src/main/java/org/onap/policy/pap/main/rest/PdpGroupDeployControllerV1.java b/main/src/main/java/org/onap/policy/pap/main/rest/PdpGroupDeployControllerV1.java index 7357771d..86d730f2 100644 --- a/main/src/main/java/org/onap/policy/pap/main/rest/PdpGroupDeployControllerV1.java +++ b/main/src/main/java/org/onap/policy/pap/main/rest/PdpGroupDeployControllerV1.java @@ -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, diff --git a/main/src/main/java/org/onap/policy/pap/main/rest/PdpGroupQueryControllerV1.java b/main/src/main/java/org/onap/policy/pap/main/rest/PdpGroupQueryControllerV1.java index 1edf2293..c28b91e4 100644 --- a/main/src/main/java/org/onap/policy/pap/main/rest/PdpGroupQueryControllerV1.java +++ b/main/src/main/java/org/onap/policy/pap/main/rest/PdpGroupQueryControllerV1.java @@ -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, diff --git a/main/src/main/java/org/onap/policy/pap/main/rest/PdpGroupStateChangeControllerV1.java b/main/src/main/java/org/onap/policy/pap/main/rest/PdpGroupStateChangeControllerV1.java index 8610c521..9435296d 100644 --- a/main/src/main/java/org/onap/policy/pap/main/rest/PdpGroupStateChangeControllerV1.java +++ b/main/src/main/java/org/onap/policy/pap/main/rest/PdpGroupStateChangeControllerV1.java @@ -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, diff --git a/main/src/main/java/org/onap/policy/pap/main/rest/PolicyAuditControllerV1.java b/main/src/main/java/org/onap/policy/pap/main/rest/PolicyAuditControllerV1.java index 7848cf38..ccbc9468 100644 --- a/main/src/main/java/org/onap/policy/pap/main/rest/PolicyAuditControllerV1.java +++ b/main/src/main/java/org/onap/policy/pap/main/rest/PolicyAuditControllerV1.java @@ -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, diff --git a/main/src/main/java/org/onap/policy/pap/main/rest/PolicyComponentsHealthCheckControllerV1.java b/main/src/main/java/org/onap/policy/pap/main/rest/PolicyComponentsHealthCheckControllerV1.java index 691e0dc8..4e9a827f 100644 --- a/main/src/main/java/org/onap/policy/pap/main/rest/PolicyComponentsHealthCheckControllerV1.java +++ b/main/src/main/java/org/onap/policy/pap/main/rest/PolicyComponentsHealthCheckControllerV1.java @@ -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, diff --git a/main/src/main/java/org/onap/policy/pap/main/rest/PolicyStatusControllerV1.java b/main/src/main/java/org/onap/policy/pap/main/rest/PolicyStatusControllerV1.java index c46845ad..7333432e 100644 --- a/main/src/main/java/org/onap/policy/pap/main/rest/PolicyStatusControllerV1.java +++ b/main/src/main/java/org/onap/policy/pap/main/rest/PolicyStatusControllerV1.java @@ -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, diff --git a/main/src/main/java/org/onap/policy/pap/main/rest/StatisticsRestControllerV1.java b/main/src/main/java/org/onap/policy/pap/main/rest/StatisticsRestControllerV1.java index b08964bc..fb64b058 100644 --- a/main/src/main/java/org/onap/policy/pap/main/rest/StatisticsRestControllerV1.java +++ b/main/src/main/java/org/onap/policy/pap/main/rest/StatisticsRestControllerV1.java @@ -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, -- cgit 1.2.3-korg