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>
@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,
@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,
@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,
@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,
@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,
@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,
@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,
@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,
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,
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,
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,
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,
@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,
@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,
@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,
@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,
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,
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,
@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,
@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,
@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,
@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,