PolicyAudit=org.onap.policy.models.pap.concepts.PolicyAudit,
PolicyStatus=org.onap.policy.models.pap.concepts.PolicyStatus
</importMappings>
+ <typeMappings>
+ PdpStatistics=org.onap.policy.models.pdp.concepts.PdpStatistics
+ </typeMappings>
<configOptions>
<sourceFolder>src/gen/java</sourceFolder>
<dateLibrary>java11</dateLibrary>
/*-
* ============LICENSE_START=======================================================
- * Copyright (C) 2019,2021 Nordix Foundation.
+ * Copyright (C) 2019-2023 Nordix Foundation.
* Modifications Copyright (C) 2019 AT&T Intellectual Property.
* Modifications Copyright (C) 2021-2022 Bell Canada. All rights reserved.
* ================================================================================
package org.onap.policy.pap.main.rest;
-import io.swagger.annotations.ApiOperation;
-import io.swagger.annotations.ApiResponse;
-import io.swagger.annotations.ApiResponses;
-import io.swagger.annotations.Authorization;
import lombok.RequiredArgsConstructor;
import org.onap.policy.common.endpoints.report.HealthCheckReport;
import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.GetMapping;
-import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* @author Ram Krishna Verma (ram.krishna.verma@est.tech)
*/
@RestController
-@RequestMapping(path = "/policy/pap/v1")
@RequiredArgsConstructor
-public class HealthCheckRestControllerV1 extends PapRestControllerV1 {
+public class HealthCheckRestControllerV1 extends PapRestControllerV1 implements HealthCheckRestControllerV1Api {
private final HealthCheckProvider provider;
- @GetMapping("healthcheck")
- @ApiOperation(value = "Perform healthcheck",
- notes = "Returns healthy status of the Policy Administration component",
- response = HealthCheckReport.class, authorizations = @Authorization(value = AUTHORIZATION_TYPE))
- @ApiResponses(value = {@ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
- @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
- @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)})
+ @Override
public ResponseEntity<HealthCheckReport> healthcheck() {
var report = provider.performHealthCheck(true);
return ResponseEntity.status(report.getCode()).body(report);
/*-
* ============LICENSE_START=======================================================
- * Copyright (C) 2019-2022 Nordix Foundation.
+ * Copyright (C) 2019-2023 Nordix Foundation.
* Modifications Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
* Modifications Copyright (C) 2021 Bell Canada. All rights reserved.
* ================================================================================
package org.onap.policy.pap.main.rest;
-import io.swagger.annotations.BasicAuthDefinition;
-import io.swagger.annotations.Info;
-import io.swagger.annotations.SecurityDefinition;
-import io.swagger.annotations.SwaggerDefinition;
-import io.swagger.annotations.Tag;
import java.net.HttpURLConnection;
import java.util.Objects;
import java.util.UUID;
-import javax.ws.rs.core.MediaType;
import org.onap.policy.models.base.PfModelException;
import org.springframework.http.ResponseEntity.BodyBuilder;
import org.springframework.security.core.Authentication;
import org.springframework.security.core.context.SecurityContextHolder;
+import org.springframework.web.bind.annotation.RequestMapping;
/**
* Version v1 common superclass to provide REST endpoints for PAP component.
*
* @author Ram Krishna Verma (ram.krishna.verma@est.tech)
*/
-// @formatter:off
-@SwaggerDefinition(
- info = @Info(description =
- "Policy Administration is responsible for the deployment life cycle of policies as well as "
- + "interworking with the mechanisms required to orchestrate the nodes and containers on which "
- + "policies run. It is also responsible for the administration of policies at run time;"
- + " ensuring that policies are available to users, that policies are executing correctly,"
- + " and that the state and status of policies is monitored", version = "v1.0",
- title = "Policy Administration"),
- consumes = {MediaType.APPLICATION_JSON, PapRestControllerV1.APPLICATION_YAML},
- produces = {MediaType.APPLICATION_JSON, PapRestControllerV1.APPLICATION_YAML},
- schemes = {SwaggerDefinition.Scheme.HTTP, SwaggerDefinition.Scheme.HTTPS},
- tags = {@Tag(name = "policy-administration", description = "Policy Administration Service Operations")},
- securityDefinition = @SecurityDefinition(basicAuthDefinitions = {@BasicAuthDefinition(key = "basicAuth")}))
-// @formatter:on
+@RequestMapping
public class PapRestControllerV1 {
public static final String APPLICATION_YAML = "application/yaml";
* ============LICENSE_START=======================================================
* ONAP PAP
* ================================================================================
- * Copyright (C) 2019,2021 Nordix Foundation.
+ * Copyright (C) 2019-2023 Nordix Foundation.
* Modifications Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
* Modifications Copyright (C) 2021 Bell Canada. All rights reserved.
* ================================================================================
package org.onap.policy.pap.main.rest;
-import io.swagger.annotations.ApiOperation;
-import io.swagger.annotations.ApiParam;
-import io.swagger.annotations.ApiResponse;
-import io.swagger.annotations.ApiResponses;
-import io.swagger.annotations.Authorization;
-import io.swagger.annotations.Extension;
-import io.swagger.annotations.ExtensionProperty;
-import io.swagger.annotations.ResponseHeader;
import java.util.UUID;
import lombok.RequiredArgsConstructor;
import org.onap.policy.models.base.PfModelException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.PostMapping;
-import org.springframework.web.bind.annotation.RequestBody;
-import org.springframework.web.bind.annotation.RequestHeader;
-import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* Class to provide REST end points for PAP component to create or update PDP groups.
*/
@RestController
-@RequestMapping(path = "/policy/pap/v1")
@RequiredArgsConstructor
-public class PdpGroupCreateOrUpdateControllerV1 extends PapRestControllerV1 {
+public class PdpGroupCreateOrUpdateControllerV1 extends PapRestControllerV1
+ implements PdpGroupCreateOrUpdateControllerV1Api {
+
private static final Logger logger = LoggerFactory.getLogger(PdpGroupCreateOrUpdateControllerV1.class);
private final PdpGroupCreateOrUpdateProvider provider;
* @param groups PDP group configuration
* @return a response
*/
- // @formatter:off
- @PostMapping("pdps/groups/batch")
- @ApiOperation(value = "Create or update PDP Groups",
- notes = "Create or update one or more PDP Groups, returning optional error details",
- response = PdpGroupUpdateResponse.class,
- tags = {"PdpGroup Create/Update"},
- authorizations = @Authorization(value = AUTHORIZATION_TYPE),
- responseHeaders = {
- @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
- response = UUID.class)},
- extensions = {
- @Extension(name = EXTENSION_NAME,
- properties = {
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
- @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
- })
- })
- @ApiResponses(value = {
- @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
- @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
- @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
- })
- // @formatter:on
-
- public ResponseEntity<PdpGroupUpdateResponse> createOrUpdateGroups(
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
- required = false,
- value = REQUEST_ID_NAME) final UUID requestId,
- @ApiParam(value = "List of PDP Group Configuration", required = true) @RequestBody PdpGroups groups) {
+ @Override
+ public ResponseEntity<PdpGroupUpdateResponse> createOrUpdateGroups(UUID requestId, PdpGroups groups) {
return doOperation(requestId, "create groups failed", () -> provider.createOrUpdateGroups(groups));
}
* ONAP PAP
* ================================================================================
* Copyright (C) 2019, 2021 AT&T Intellectual Property. All rights reserved.
- * Modifications Copyright (C) 2021-2022 Nordix Foundation.
+ * Modifications Copyright (C) 2021-2023 Nordix Foundation.
* Modifications Copyright (C) 2021 Bell Canada. All rights reserved.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Timer;
-import io.swagger.annotations.ApiOperation;
-import io.swagger.annotations.ApiParam;
-import io.swagger.annotations.ApiResponse;
-import io.swagger.annotations.ApiResponses;
-import io.swagger.annotations.Authorization;
-import io.swagger.annotations.Extension;
-import io.swagger.annotations.ExtensionProperty;
-import io.swagger.annotations.ResponseHeader;
import java.time.Duration;
import java.time.Instant;
import java.util.UUID;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.DeleteMapping;
-import org.springframework.web.bind.annotation.PathVariable;
-import org.springframework.web.bind.annotation.RequestHeader;
-import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* Class to provide REST end points for PAP component to delete a PDP group.
*/
@RestController
-@RequestMapping(path = "/policy/pap/v1")
@RequiredArgsConstructor
-public class PdpGroupDeleteControllerV1 extends PapRestControllerV1 {
+public class PdpGroupDeleteControllerV1 extends PapRestControllerV1
+ implements PdpGroupDeleteControllerV1Api {
+
private static final Logger logger = LoggerFactory.getLogger(PdpGroupDeleteControllerV1.class);
private final PdpGroupDeleteProvider provider;
* @param groupName name of the PDP group to be deleted
* @return a response
*/
- // @formatter:off
- @DeleteMapping("pdps/groups/{name}")
- @ApiOperation(value = "Delete PDP Group",
- notes = "Deletes a PDP Group, returning optional error details",
- response = PdpGroupDeleteResponse.class,
- tags = {"PdpGroup Delete"},
- authorizations = @Authorization(value = AUTHORIZATION_TYPE),
- responseHeaders = {
- @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
- response = UUID.class)},
- extensions = {
- @Extension(name = EXTENSION_NAME,
- properties = {
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
- @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
- })
- })
- @ApiResponses(value = {
- @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
- @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
- @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
- })
- // @formatter:on
- public ResponseEntity<PdpGroupDeleteResponse> deleteGroup(
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
- required = false,
- value = REQUEST_ID_NAME) final UUID requestId,
- @ApiParam(value = "PDP Group Name") @PathVariable("name") String groupName) {
+ @Override
+ public ResponseEntity<PdpGroupDeleteResponse> deleteGroup(String groupName, UUID requestId) {
return doOperation(requestId, () -> provider.deleteGroup(groupName));
}
* @param policyName name of the PDP Policy to be deleted
* @return a response
*/
- // @formatter:off
- @DeleteMapping("pdps/policies/{name}")
- @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 = {"PdpGroup Delete"},
- authorizations = @Authorization(value = AUTHORIZATION_TYPE),
- responseHeaders = {
- @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
- response = UUID.class)},
- extensions = {
- @Extension(name = EXTENSION_NAME,
- properties = {
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
- @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
- })
- })
- @ApiResponses(value = {
- @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
- @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
- @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
- })
- // @formatter:on
- public ResponseEntity<PdpGroupDeployResponse> deletePolicy(
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
- required = false,
- value = REQUEST_ID_NAME) final UUID requestId,
- @ApiParam(value = "PDP Policy Name") @PathVariable("name") String policyName) {
-
+ @Override
+ public ResponseEntity<PdpGroupDeployResponse> deletePolicy(String policyName, UUID requestId) {
return doUndeployOperation(requestId,
() -> provider.undeploy(new ToscaConceptIdentifierOptVersion(policyName, null), getPrincipal()));
}
* @param version version to be deleted
* @return a response
*/
- // @formatter:off
- @DeleteMapping("pdps/policies/{name}/versions/{version}")
- @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 = {"PdpGroup Delete"},
- authorizations = @Authorization(value = AUTHORIZATION_TYPE),
- responseHeaders = {
- @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
- response = UUID.class)},
- extensions = {
- @Extension(name = EXTENSION_NAME,
- properties = {
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
- @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
- })
- })
- @ApiResponses(value = {
- @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
- @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
- @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
- })
- // @formatter:on
+ @Override
public ResponseEntity<PdpGroupDeployResponse> deletePolicyVersion(
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
- required = false,
- value = REQUEST_ID_NAME) final UUID requestId,
- @ApiParam(value = "PDP Policy Name") @PathVariable("name") String policyName,
- @ApiParam(value = "PDP Policy Version") @PathVariable("version") String version) {
-
+ String policyName,
+ String version,
+ UUID requestId) {
return doUndeployOperation(requestId,
() -> provider.undeploy(new ToscaConceptIdentifierOptVersion(policyName, version), getPrincipal()));
}
* ================================================================================
* Copyright (C) 2019, 2021 AT&T Intellectual Property. All rights reserved.
* Modifications Copyright (C) 2021 Bell Canada. All rights reserved.
- * Modifications Copyright (C) 2022 Nordix Foundation.
+ * Modifications Copyright (C) 2022-2023 Nordix Foundation.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Timer;
-import io.swagger.annotations.ApiOperation;
-import io.swagger.annotations.ApiParam;
-import io.swagger.annotations.ApiResponse;
-import io.swagger.annotations.ApiResponses;
-import io.swagger.annotations.Authorization;
-import io.swagger.annotations.Extension;
-import io.swagger.annotations.ExtensionProperty;
-import io.swagger.annotations.ResponseHeader;
import java.time.Duration;
import java.time.Instant;
import java.util.UUID;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.PostMapping;
-import org.springframework.web.bind.annotation.RequestBody;
-import org.springframework.web.bind.annotation.RequestHeader;
-import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* Class to provide REST end points for PAP component to deploy a PDP group.
*/
@RestController
-@RequestMapping(path = "/policy/pap/v1")
@RequiredArgsConstructor
-public class PdpGroupDeployControllerV1 extends PapRestControllerV1 {
+public class PdpGroupDeployControllerV1 extends PapRestControllerV1 implements PdpGroupDeployControllerV1Api {
public static final String POLICY_STATUS_URI = "/policy/pap/v1/policies/status";
public static final String DEPLOYMENT_RESPONSE_MSG = "Use the policy status url to fetch the latest status. "
* @param groups PDP group configuration
* @return a response
*/
- // @formatter:off
- @PostMapping("pdps/deployments/batch")
- @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 = {"Deployments Update"},
- authorizations = @Authorization(value = AUTHORIZATION_TYPE),
- responseHeaders = {
- @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
- response = UUID.class)},
- extensions = {
- @Extension(name = EXTENSION_NAME,
- properties = {
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
- @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
- })
- })
- @ApiResponses(value = {
- @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
- @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
- @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
- })
- // @formatter:on
- public ResponseEntity<PdpGroupDeployResponse> updateGroupPolicies(
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
- required = false,
- value = REQUEST_ID_NAME) final UUID requestId,
- @ApiParam(value = "List of PDP Group Deployments", required = true) @RequestBody DeploymentGroups groups) {
+ @Override
+ public ResponseEntity<PdpGroupDeployResponse> updateGroupPolicies(UUID requestId, DeploymentGroups groups) {
return doOperation(requestId, "update policy deployments failed",
() -> provider.updateGroupPolicies(groups, getPrincipal()));
}
* @param policies PDP policies
* @return a response
*/
- // @formatter:off
- @PostMapping("pdps/policies")
- @ApiOperation(value = "Deploy or update PDP Policies",
- notes = "Deploys or updates PDP Policies, returning optional error details",
- response = PdpGroupDeployResponse.class,
- tags = {"Deployments Update"},
- authorizations = @Authorization(value = AUTHORIZATION_TYPE),
- responseHeaders = {
- @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
- response = UUID.class)},
- extensions = {
- @Extension(name = EXTENSION_NAME,
- properties = {
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
- @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
- })
- })
- @ApiResponses(value = {
- @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
- @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
- @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
- })
- // @formatter:on
- public ResponseEntity<PdpGroupDeployResponse> deployPolicies(
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
- required = false,
- value = REQUEST_ID_NAME) final UUID requestId,
- @ApiParam(value = "PDP Policies; only the name is required") @RequestBody PdpDeployPolicies policies) {
+ @Override
+ public ResponseEntity<PdpGroupDeployResponse> deployPolicies(UUID requestId, PdpDeployPolicies policies) {
return doOperation(requestId, "deploy policies failed",
() -> provider.deployPolicies(policies, getPrincipal()));
}
/*-
* ============LICENSE_START=======================================================
- * Copyright (C) 2019,2021 Nordix Foundation.
+ * Copyright (C) 2019-2023 Nordix Foundation.
* Modifications Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
* Modifications Copyright (C) 2021 Bell Canada. All rights reserved.
* ================================================================================
package org.onap.policy.pap.main.rest;
-import io.swagger.annotations.ApiOperation;
-import io.swagger.annotations.ApiParam;
-import io.swagger.annotations.ApiResponse;
-import io.swagger.annotations.ApiResponses;
-import io.swagger.annotations.Authorization;
-import io.swagger.annotations.Extension;
-import io.swagger.annotations.ExtensionProperty;
-import io.swagger.annotations.ResponseHeader;
import java.util.UUID;
import lombok.RequiredArgsConstructor;
import org.apache.commons.lang3.tuple.Pair;
import org.onap.policy.models.base.PfModelException;
import org.onap.policy.models.pdp.concepts.Pdps;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.GetMapping;
-import org.springframework.web.bind.annotation.RequestHeader;
-import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
*/
@RestController
-@RequestMapping(path = "/policy/pap/v1")
@RequiredArgsConstructor
-public class PdpGroupHealthCheckControllerV1 extends PapRestControllerV1 {
+public class PdpGroupHealthCheckControllerV1 extends PapRestControllerV1
+ implements PdpGroupHealthCheckControllerV1Api {
+ private static final Logger logger = LoggerFactory.getLogger(PdpGroupHealthCheckControllerV1.class);
private final PdpGroupHealthCheckProvider provider;
/**
*
* @param requestId request ID used in ONAP logging
* @return a response
+ * @throws PfModelException Exception thrown by fetchPdpGroupHealthStatus
*/
- // @formatter:off
- @GetMapping("pdps/healthcheck")
- @ApiOperation(value = "Returns health status of all PDPs registered with PAP",
- notes = "Queries health status of all PDPs, returning all pdps health status",
- response = Pdps.class,
- tags = {"Policy Administration (PAP) API"},
- authorizations = @Authorization(value = AUTHORIZATION_TYPE),
- responseHeaders = {
- @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
- response = UUID.class)},
- extensions = {
- @Extension(name = EXTENSION_NAME,
- properties = {
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
- @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
- })
- })
- @ApiResponses(value = {
- @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
- @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
- @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
- })
- // @formatter:on
- public ResponseEntity<Pdps> pdpGroupHealthCheck(@ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
- required = false,
- value = REQUEST_ID_NAME) final UUID requestId) throws PfModelException {
- Pair<HttpStatus, Pdps> pair = provider.fetchPdpGroupHealthStatus();
- return addLoggingHeaders(addVersionControlHeaders(ResponseEntity.status(pair.getLeft())), requestId)
- .body(pair.getRight());
+ @Override
+ public ResponseEntity<Pdps> pdpGroupHealthCheck(UUID requestId) {
+ try {
+ Pair<HttpStatus, Pdps> pair = provider.fetchPdpGroupHealthStatus();
+ return addLoggingHeaders(addVersionControlHeaders(ResponseEntity.status(pair.getLeft())), requestId)
+ .body(pair.getRight());
+ } catch (PfModelException e) {
+ logger.warn("fetch Pdp Group Health Status failed", e);
+ return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR);
+ }
+
}
}
/*-
* ============LICENSE_START=======================================================
- * Copyright (C) 2019,2021 Nordix Foundation.
+ * Copyright (C) 2019-2023 Nordix Foundation.
* Modifications Copyright (C) 2019, 2021 AT&T Intellectual Property.
* Modifications Copyright (C) 2021-2022 Bell Canada. All rights reserved.
* ================================================================================
package org.onap.policy.pap.main.rest;
-import io.swagger.annotations.ApiOperation;
-import io.swagger.annotations.ApiParam;
-import io.swagger.annotations.ApiResponse;
-import io.swagger.annotations.ApiResponses;
-import io.swagger.annotations.Authorization;
-import io.swagger.annotations.Extension;
-import io.swagger.annotations.ExtensionProperty;
-import io.swagger.annotations.ResponseHeader;
import java.util.UUID;
import lombok.RequiredArgsConstructor;
import org.onap.policy.models.base.PfModelException;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.GetMapping;
-import org.springframework.web.bind.annotation.RequestHeader;
-import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* @author Ram Krishna Verma (ram.krishna.verma@est.tech)
*/
@RestController
-@RequestMapping(path = "/policy/pap/v1")
@RequiredArgsConstructor
-public class PdpGroupQueryControllerV1 extends PapRestControllerV1 {
+public class PdpGroupQueryControllerV1 extends PapRestControllerV1 implements PdpGroupQueryControllerV1Api {
private static final Logger LOGGER = LoggerFactory.getLogger(PdpGroupQueryControllerV1.class);
* @return a response
* @throws PfModelException the exception
*/
- // @formatter:off
- @GetMapping("pdps")
- @ApiOperation(value = "Query details of all PDP groups",
- notes = "Queries details of all PDP groups, returning all group details",
- response = PdpGroups.class,
- tags = {"PdpGroup Query"},
- authorizations = @Authorization(value = AUTHORIZATION_TYPE),
- responseHeaders = {
- @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
- response = UUID.class)},
- extensions = {
- @Extension(name = EXTENSION_NAME,
- properties = {
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
- @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
- })
- })
- @ApiResponses(value = {
- @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
- @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
- @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
- })
- // @formatter:on
- public ResponseEntity<PdpGroups> queryGroupDetails(@ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
- required = false,
- value = REQUEST_ID_NAME) final UUID requestId) throws PfModelException {
-
+ @Override
+ public ResponseEntity<PdpGroups> queryGroupDetails(UUID requestId) {
final var pdpGroups = new PdpGroups();
pdpGroups.setGroups(pdpGroupService.getPdpGroups());
LOGGER.debug("PdpGroup Query Response - {}", pdpGroups);
-
return addLoggingHeaders(addVersionControlHeaders(ResponseEntity.status(HttpStatus.OK)), requestId)
.body(pdpGroups);
}
/*-
* ============LICENSE_START=======================================================
- * Copyright (C) 2019-2021 Nordix Foundation.
+ * Copyright (C) 2019-2023 Nordix Foundation.
* Modifications Copyright (C) 2019, 2021 AT&T Intellectual Property.
* Modifications Copyright (C) 2021 Bell Canada. All rights reserved.
* ================================================================================
package org.onap.policy.pap.main.rest;
-import io.swagger.annotations.ApiOperation;
-import io.swagger.annotations.ApiParam;
-import io.swagger.annotations.ApiResponse;
-import io.swagger.annotations.ApiResponses;
-import io.swagger.annotations.Authorization;
-import io.swagger.annotations.Extension;
-import io.swagger.annotations.ExtensionProperty;
-import io.swagger.annotations.ResponseHeader;
import java.util.UUID;
import lombok.RequiredArgsConstructor;
import org.apache.commons.lang3.tuple.Pair;
import org.onap.policy.models.base.PfModelException;
import org.onap.policy.models.pap.concepts.PdpGroupStateChangeResponse;
import org.onap.policy.models.pdp.enums.PdpState;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.PathVariable;
-import org.springframework.web.bind.annotation.PutMapping;
-import org.springframework.web.bind.annotation.RequestHeader;
-import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
/**
* @author Ram Krishna Verma (ram.krishna.verma@est.tech)
*/
@RestController
-@RequestMapping(path = "/policy/pap/v1")
@RequiredArgsConstructor
-public class PdpGroupStateChangeControllerV1 extends PapRestControllerV1 {
+public class PdpGroupStateChangeControllerV1 extends PapRestControllerV1 implements PdpGroupStateChangeControllerV1Api {
+ private static final Logger logger = LoggerFactory.getLogger(PdpGroupHealthCheckControllerV1.class);
private final PdpGroupStateChangeProvider provider;
/**
* @param groupName name of the PDP group to be deleted
* @param state state of the PDP group
* @return a response
- * @throws PfModelException the exception
+ * @throws PfModelException Exception thrown by changeGroupState
*/
- // @formatter:off
- @PutMapping("pdps/groups/{name}")
- @ApiOperation(value = "Change state of a PDP Group",
- notes = "Changes state of PDP Group, returning optional error details",
- response = PdpGroupStateChangeResponse.class,
- tags = {"PdpGroup State Change"},
- authorizations = @Authorization(value = AUTHORIZATION_TYPE),
- responseHeaders = {
- @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
- response = UUID.class)},
- extensions = {@Extension(name = EXTENSION_NAME,
- properties = {
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
- @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
- })
- })
- @ApiResponses(value = {
- @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
- @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
- @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
- })
- // @formatter:on
+ @Override
public ResponseEntity<PdpGroupStateChangeResponse> changeGroupState(
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
- required = false,
- value = REQUEST_ID_NAME) final UUID requestId,
- @ApiParam(value = "PDP Group Name") @PathVariable("name") String groupName,
- @ApiParam(value = "PDP Group State") @RequestParam("state") final PdpState state) throws PfModelException {
-
- final Pair<HttpStatus, PdpGroupStateChangeResponse> pair = provider.changeGroupState(groupName, state);
- return addLoggingHeaders(addVersionControlHeaders(ResponseEntity.status(pair.getLeft())), requestId)
- .body(pair.getRight());
+ String groupName, PdpState state, UUID requestId) {
+ try {
+ final Pair<HttpStatus, PdpGroupStateChangeResponse> pair = provider.changeGroupState(groupName, state);
+ return addLoggingHeaders(addVersionControlHeaders(ResponseEntity.status(pair.getLeft())), requestId)
+ .body(pair.getRight());
+ } catch (PfModelException e) {
+ logger.warn("changeGroupState failed", e);
+ }
+ return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR);
}
}
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2021-2022 Bell Canada. All rights reserved.
+ * Modifications Copyright (C) 2023 Nordix Foundation.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
package org.onap.policy.pap.main.rest;
-import io.swagger.annotations.ApiOperation;
-import io.swagger.annotations.ApiParam;
-import io.swagger.annotations.ApiResponse;
-import io.swagger.annotations.ApiResponses;
-import io.swagger.annotations.Authorization;
-import io.swagger.annotations.Extension;
-import io.swagger.annotations.ExtensionProperty;
-import io.swagger.annotations.ResponseHeader;
import java.time.Instant;
import java.util.Collection;
+import java.util.List;
import java.util.UUID;
import lombok.RequiredArgsConstructor;
import org.onap.policy.models.base.PfModelException;
import org.onap.policy.pap.main.service.PolicyAuditService;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.GetMapping;
-import org.springframework.web.bind.annotation.PathVariable;
-import org.springframework.web.bind.annotation.RequestHeader;
-import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
/**
* various operations on policies.
*/
@RestController
-@RequestMapping(path = "/policy/pap/v1")
@RequiredArgsConstructor
-public class PolicyAuditControllerV1 extends PapRestControllerV1 {
+public class PolicyAuditControllerV1 extends PapRestControllerV1 implements PolicyAuditControllerV1Api {
public static final String NO_AUDIT_RECORD_FOUND = "No records found matching the input parameters";
* @return a response
* @throws PfModelException the exception
*/
- // @formatter:off
- @GetMapping("policies/audit")
- @ApiOperation(value = "Queries audit information for all the policies",
- 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 Audit"},
- authorizations = @Authorization(value = AUTHORIZATION_TYPE),
- responseHeaders = {
- @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
- response = UUID.class)},
- extensions = {
- @Extension(name = EXTENSION_NAME,
- properties = {
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
- @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
- })
- })
- @ApiResponses(value = {
- @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
- @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
- @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
- })
- // @formatter:on
- public ResponseEntity<Collection<PolicyAudit>> getAllAuditRecords(
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
- required = false,
- value = REQUEST_ID_NAME) final UUID requestId,
- @ApiParam(value = "Record count between 1-100") @RequestParam(
- defaultValue = "10",
- required = false,
- value = "recordCount") final int recordCount,
- @ApiParam(value = "Start time in epoch timestamp") @RequestParam(
- required = false,
- value = "startTime") final Long startTime,
- @ApiParam(value = "End time in epoch timestamp") @RequestParam(
- required = false,
- value = "endTime") final Long endTime)
- throws PfModelException {
+ @Override
+ public ResponseEntity<List<PolicyAudit>> getAllAuditRecords(
+ UUID requestId,
+ Integer recordCount,
+ Long startTime,
+ Long endTime) {
return addLoggingHeaders(addVersionControlHeaders(ResponseEntity.ok()), requestId).body(policyAuditService
.getAuditRecords(recordCount, convertEpochtoInstant(startTime), convertEpochtoInstant(endTime)));
* @return a response
* @throws PfModelException the exception
*/
- // @formatter:off
- @GetMapping("policies/audit/{pdpGroupName}")
- @ApiOperation(value = "Queries audit information for all the policies in a PdpGroup",
- 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 Audit"},
- authorizations = @Authorization(value = AUTHORIZATION_TYPE),
- responseHeaders = {
- @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
- response = UUID.class)},
- extensions = {
- @Extension(name = EXTENSION_NAME,
- properties = {
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
- @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
- })
- })
- @ApiResponses(value = {
- @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
- @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
- @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
- })
- // @formatter:on
+ @Override
public ResponseEntity<Object> getAuditRecordsByGroup(
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
- required = false,
- value = REQUEST_ID_NAME) final UUID requestId,
- @ApiParam(value = "Record count between 1-100") @RequestParam(
- defaultValue = "10",
- required = false,
- value = "recordCount") final int recordCount,
- @ApiParam(value = "Start time in epoch timestamp") @RequestParam(
- required = false,
- value = "startTime") final Long startTime,
- @ApiParam(value = "End time in epoch timestamp") @RequestParam(
- required = false,
- value = "endTime") final Long endTime,
- @ApiParam(value = "PDP Group Name") @PathVariable("pdpGroupName") String pdpGroupName) throws PfModelException {
+ String pdpGroupName,
+ UUID requestId,
+ Integer recordCount,
+ Long startTime,
+ Long endTime) {
return makeOkOrNotFoundResponse(requestId, policyAuditService.getAuditRecords(pdpGroupName, recordCount,
convertEpochtoInstant(startTime), convertEpochtoInstant(endTime)));
* @return a response
* @throws PfModelException the exception
*/
- // @formatter:off
- @GetMapping("policies/audit/{pdpGroupName}/{policyName}/{policyVersion}")
- @ApiOperation(value = "Queries audit information for a specific version of a policy in a PdpGroup",
- 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 Audit"},
- authorizations = @Authorization(value = AUTHORIZATION_TYPE),
- responseHeaders = {
- @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
- response = UUID.class)},
- extensions = {
- @Extension(name = EXTENSION_NAME,
- properties = {
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
- @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
- })
- })
- @ApiResponses(value = {
- @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
- @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
- @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
- })
- // @formatter:on
-
- public ResponseEntity<Object> getAuditRecordsOfPolicy(
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
- required = false,
- value = REQUEST_ID_NAME) final UUID requestId,
- @ApiParam(value = "Record count between 1-100", required = false) @RequestParam(
- defaultValue = "10",
- required = false,
- value = "recordCount") final int recordCount,
- @ApiParam(value = "Start time in epoch timestamp", required = false) @RequestParam(
- required = false,
- value = "startTime") final Long startTime,
- @ApiParam(value = "End time in epoch timestamp") @RequestParam(
- required = false,
- value = "endTime") final Long endTime,
- @ApiParam(value = "PDP Group Name") @PathVariable("pdpGroupName") String pdpGroupName,
- @ApiParam(value = "Policy Name") @PathVariable("policyName") String policyName,
- @ApiParam(value = "Policy Version") @PathVariable(value = "policyVersion") String policyVersion)
- throws PfModelException {
+ @Override
+ public ResponseEntity<Object> getAuditRecordsOfPolicyinPdpGroup(
+ String pdpGroupName,
+ String policyName,
+ String policyVersion,
+ UUID requestId,
+ Integer recordCount,
+ Long startTime,
+ Long endTime) {
return makeOkOrNotFoundResponse(requestId, policyAuditService.getAuditRecords(pdpGroupName, policyName,
policyVersion, recordCount, convertEpochtoInstant(startTime), convertEpochtoInstant(endTime)));
* @return a response
* @throws PfModelException the exception
*/
- // @formatter:off
- @GetMapping("policies/audit/{policyName}/{policyVersion}")
- @ApiOperation(value = "Queries audit information for a specific version of a policy",
- notes = "Queries audit information for a specific version of a policy,"
- + " returning audit information for the policy",
- response = PolicyAudit.class,
- tags = {"Policy Audit"},
- authorizations = @Authorization(value = AUTHORIZATION_TYPE),
- responseHeaders = {
- @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
- response = UUID.class)},
- extensions = {
- @Extension(name = EXTENSION_NAME,
- properties = {
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
- @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
- })
- })
- @ApiResponses(value = {
- @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
- @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
- @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
- })
- // @formatter:on
-
+ @Override
public ResponseEntity<Object> getAuditRecordsOfPolicy(
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
- required = false,
- value = REQUEST_ID_NAME) final UUID requestId,
- @ApiParam(value = "Record count between 1-100") @RequestParam(
- defaultValue = "10",
- required = false,
- value = "recordCount") final int recordCount,
- @ApiParam(value = "Start time in epoch timestamp") @RequestParam(
- required = false,
- value = "startTime") final Long startTime,
- @ApiParam(value = "End time in epoch timestamp") @RequestParam(
- required = false,
- value = "endTime") final Long endTime,
- @ApiParam(value = "Policy Name") @PathVariable(required = true, value = "policyName") String policyName,
- @ApiParam(
- value = "Policy Version") @PathVariable(required = true, value = "policyVersion") String policyVersion)
- throws PfModelException {
+ String policyName,
+ String policyVersion,
+ UUID requestId,
+ Integer recordCount,
+ Long startTime,
+ Long endTime) {
return makeOkOrNotFoundResponse(requestId, policyAuditService.getAuditRecords(policyName, policyVersion,
recordCount, convertEpochtoInstant(startTime), convertEpochtoInstant(endTime)));
package org.onap.policy.pap.main.rest;
-import io.swagger.annotations.ApiOperation;
-import io.swagger.annotations.ApiParam;
-import io.swagger.annotations.ApiResponse;
-import io.swagger.annotations.ApiResponses;
-import io.swagger.annotations.Authorization;
-import io.swagger.annotations.Extension;
-import io.swagger.annotations.ExtensionProperty;
-import io.swagger.annotations.ResponseHeader;
import java.util.Map;
import java.util.UUID;
import lombok.RequiredArgsConstructor;
import org.apache.commons.lang3.tuple.Pair;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.GetMapping;
-import org.springframework.web.bind.annotation.RequestHeader;
-import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* @author Yehui Wang (yehui.wang@est.tech)
*/
@RestController
-@RequestMapping(path = "/policy/pap/v1")
@RequiredArgsConstructor
-public class PolicyComponentsHealthCheckControllerV1 extends PapRestControllerV1 {
+public class PolicyComponentsHealthCheckControllerV1 extends PapRestControllerV1
+ implements PolicyComponentsHealthCheckControllerV1Api {
private final PolicyComponentsHealthCheckProvider provider;
* @param requestId request ID used in ONAP logging
* @return a response
*/
- // @formatter:off
- @GetMapping("components/healthcheck")
- @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 = {"Consolidated Healthcheck"},
- authorizations = @Authorization(value = AUTHORIZATION_TYPE),
- responseHeaders = {
- @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
- response = UUID.class)},
- extensions = {
- @Extension(name = EXTENSION_NAME,
- properties = {
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
- @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
- })
- })
- @ApiResponses(value = {
- @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
- @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
- @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
- })
- // @formatter:on
- public ResponseEntity<Map<String, Object>> policyComponentsHealthCheck(
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
- required = false,
- value = REQUEST_ID_NAME) final UUID requestId) {
+ @Override
+ public ResponseEntity<Map<String, Object>> policyComponentsHealthCheck(UUID requestId) {
final Pair<HttpStatus, Map<String, Object>> pair = provider.fetchPolicyComponentsHealthStatus();
return addLoggingHeaders(addVersionControlHeaders(ResponseEntity.status(pair.getLeft())), requestId)
.body(pair.getRight());
* ONAP PAP
* ================================================================================
* Copyright (C) 2019, 2021 AT&T Intellectual Property. All rights reserved.
- * Modifications Copyright (C) 2021 Nordix Foundation.
+ * Modifications Copyright (C) 2021-2023 Nordix Foundation.
* Modifications Copyright (C) 2021-2022 Bell Canada. All rights reserved.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
package org.onap.policy.pap.main.rest;
import com.google.re2j.PatternSyntaxException;
-import io.swagger.annotations.ApiOperation;
-import io.swagger.annotations.ApiParam;
-import io.swagger.annotations.ApiResponse;
-import io.swagger.annotations.ApiResponses;
-import io.swagger.annotations.Authorization;
-import io.swagger.annotations.Extension;
-import io.swagger.annotations.ExtensionProperty;
-import io.swagger.annotations.ResponseHeader;
import java.util.Collection;
import java.util.UUID;
import lombok.RequiredArgsConstructor;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.GetMapping;
-import org.springframework.web.bind.annotation.PathVariable;
-import org.springframework.web.bind.annotation.RequestHeader;
-import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
/**
* policies.
*/
@RestController
-@RequestMapping(path = "/policy/pap/v1")
@RequiredArgsConstructor
-public class PolicyStatusControllerV1 extends PapRestControllerV1 {
+public class PolicyStatusControllerV1 extends PapRestControllerV1 implements PolicyStatusControllerV1Api {
private static final String EMPTY_REGEX_ERROR_MESSAGE = "An empty string passed as a regex is not allowed";
private static final String EMPTY_REGEX_WARNING = ". Empty string passed as Regex.";
private static final String GET_DEPLOYMENTS_FAILED = "get deployments failed";
* @param regex regex for a policy name
* @return a response
*/
- // @formatter:off
- @GetMapping("policies/deployed")
- @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 Deployment Status"},
- authorizations = @Authorization(value = AUTHORIZATION_TYPE),
- responseHeaders = {
- @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
- response = UUID.class)},
- extensions = {
- @Extension(name = EXTENSION_NAME,
- properties = {
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
- @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
- })
- })
- @ApiResponses(value = {
- @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
- @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
- @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
- })
- // @formatter:on
-
- public ResponseEntity<Object> queryAllDeployedPolicies(
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
- required = false,
- value = REQUEST_ID_NAME) final UUID requestId,
- @ApiParam(value = "Regex for a policy name") @RequestParam(required = false, value = "regex") String regex) {
+ @Override
+ public ResponseEntity<Object> queryAllDeployedPolicies(UUID requestId, String regex) {
try {
final Collection<PolicyStatus> result;
if (regex == null) {
* @param requestId request ID used in ONAP logging
* @return a response
*/
- // @formatter:off
- @GetMapping("policies/deployed/{name}")
- @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 Deployment Status"},
- authorizations = @Authorization(value = AUTHORIZATION_TYPE),
- responseHeaders = {
- @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
- response = UUID.class)},
- extensions = {
- @Extension(name = EXTENSION_NAME,
- properties = {
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
- @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
- })
- })
- @ApiResponses(value = {
- @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
- @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
- @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
- })
- // @formatter:on
-
- public ResponseEntity<Object> queryDeployedPolicies(
- @ApiParam(value = "Policy Id") @PathVariable("name") String name,
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
- required = false,
- value = REQUEST_ID_NAME) final UUID requestId) {
+ @Override
+ public ResponseEntity<Object> queryDeployedPolicies(String name, UUID requestId) {
try {
Collection<PolicyStatus> result = provider.getStatus(new ToscaConceptIdentifierOptVersion(name, null));
* @param requestId request ID used in ONAP logging
* @return a response
*/
- // @formatter:off
- @GetMapping("policies/deployed/{name}/{version}")
- @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 Deployment Status"},
- authorizations = @Authorization(value = AUTHORIZATION_TYPE),
- responseHeaders = {
- @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
- response = UUID.class)},
- extensions = {
- @Extension(name = EXTENSION_NAME,
- properties = {
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
- @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
- })
- })
- @ApiResponses(value = {
- @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
- @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
- @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
- })
- // @formatter:on
-
- public ResponseEntity<Object> queryDeployedPolicy(@ApiParam(value = "Policy Id") @PathVariable("name") String name,
- @ApiParam(value = "Policy Version") @PathVariable("version") String version,
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
- required = false,
- value = REQUEST_ID_NAME) final UUID requestId) {
+ @Override
+ public ResponseEntity<Object> queryDeployedPolicy(String name, String version, UUID requestId) {
try {
Collection<PolicyStatus> result = provider.getStatus(new ToscaConceptIdentifierOptVersion(name, version));
* @param requestId request ID used in ONAP logging
* @return a response
*/
- // @formatter:off
- @GetMapping("policies/status")
- @ApiOperation(value = "Queries status of policies in all PdpGroups",
- 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 Status"},
- authorizations = @Authorization(value = AUTHORIZATION_TYPE),
- responseHeaders = {
- @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
- response = UUID.class)},
- extensions = {
- @Extension(name = EXTENSION_NAME,
- properties = {
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
- @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
- })
- })
- @ApiResponses(value = {
- @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
- @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
- @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
- })
- // @formatter:on
-
- public ResponseEntity<Object> getStatusOfAllPolicies(
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
- required = false,
- value = REQUEST_ID_NAME) final UUID requestId) {
+ @Override
+ public ResponseEntity<Object> getStatusOfAllPolicies(UUID requestId) {
try {
return addLoggingHeaders(addVersionControlHeaders(ResponseEntity.ok()), requestId)
* @param regex regex for a policy name
* @return a response
*/
- // @formatter:off
- @GetMapping("policies/status/{pdpGroupName}")
- @ApiOperation(value = "Queries status of policies in a specific PdpGroup",
- 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 Status"},
- authorizations = @Authorization(value = AUTHORIZATION_TYPE),
- responseHeaders = {
- @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
- response = UUID.class)},
- extensions = {
- @Extension(name = EXTENSION_NAME,
- properties = {
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
- @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
- })
- })
- @ApiResponses(value = {
- @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
- @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
- @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
- })
- // @formatter:on
-
+ @Override
public ResponseEntity<Object> getStatusOfPoliciesByGroup(
- @ApiParam(value = "PDP Group Name") @PathVariable("pdpGroupName") String pdpGroupName,
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
- required = false,
- value = REQUEST_ID_NAME) final UUID requestId,
- @ApiParam(value = "Regex for a policy name") @RequestParam(required = false, value = "regex") String regex) {
+ String pdpGroupName,
+ UUID requestId,
+ String regex) {
try {
final Collection<PdpPolicyStatus> result;
* @param requestId request ID used in ONAP logging
* @return a response
*/
- // @formatter:off
- @GetMapping("policies/status/{pdpGroupName}/{policyName}")
- @ApiOperation(value = "Queries status of all versions of a specific policy in a specific PdpGroup",
- notes = "Queries status of all versions of a specific policy in a specific PdpGroup,"
- + " returning status of all versions of the policy in the PDPs belonging to the PdpGroup",
- responseContainer = "List", response = PdpPolicyStatus.class,
- tags = {"Policy Administration (PAP) API"},
- authorizations = @Authorization(value = AUTHORIZATION_TYPE),
- responseHeaders = {
- @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
- response = UUID.class)},
- extensions = {
- @Extension(name = EXTENSION_NAME,
- properties = {
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
- @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
- })
- })
- @ApiResponses(value = {
- @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
- @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
- @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
- })
- // @formatter:on
-
+ @Override
public ResponseEntity<Object> getStatusOfPolicies(
- @ApiParam(value = "PDP Group Name") @PathVariable("pdpGroupName") String pdpGroupName,
- @ApiParam(value = "Policy Id") @PathVariable("policyName") String policyName,
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
- required = false,
- value = REQUEST_ID_NAME) final UUID requestId) {
+ String pdpGroupName,
+ String policyName,
+ UUID requestId) {
try {
Collection<PdpPolicyStatus> result =
* @param requestId request ID used in ONAP logging
* @return a response
*/
- // @formatter:off
- @GetMapping("policies/status/{pdpGroupName}/{policyName}/{policyVersion}")
- @ApiOperation(value = "Queries status of a specific version of a specific policy in a specific PdpGroup",
- notes = "Queries status of a specific version of a specific policy in a specific PdpGroup,"
- + " returning status of the policy in the PDPs belonging to the PdpGroup",
- response = PdpPolicyStatus.class,
- tags = {"Policy Administration (PAP) API"},
- authorizations = @Authorization(value = AUTHORIZATION_TYPE),
- responseHeaders = {
- @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
- response = UUID.class)},
- extensions = {
- @Extension(name = EXTENSION_NAME,
- properties = {
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
- @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
- })
- })
- @ApiResponses(value = {
- @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
- @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
- @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
- })
- // @formatter:on
+ @Override
public ResponseEntity<Object> getStatusOfPolicy(
- @ApiParam(value = "PDP Group Name") @PathVariable("pdpGroupName") String pdpGroupName,
- @ApiParam(value = "Policy Id") @PathVariable("policyName") String policyName,
- @ApiParam(value = "Policy Version") @PathVariable("policyVersion") String policyVersion,
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
- required = false,
- value = REQUEST_ID_NAME) final UUID requestId) {
+ String pdpGroupName,
+ String policyName,
+ String policyVersion,
+ UUID requestId) {
try {
Collection<PdpPolicyStatus> result = provider.getPolicyStatus(pdpGroupName,
/*-
* ============LICENSE_START=======================================================
- * Copyright (C) 2019-2021 Nordix Foundation.
+ * Copyright (C) 2019-2023 Nordix Foundation.
* Modifications Copyright (C) 2019, 2021 AT&T Intellectual Property.
* Modifications Copyright (C) 2021-2022 Bell Canada. All rights reserved.
* ================================================================================
package org.onap.policy.pap.main.rest;
-import io.swagger.annotations.ApiOperation;
-import io.swagger.annotations.ApiParam;
-import io.swagger.annotations.ApiResponse;
-import io.swagger.annotations.ApiResponses;
-import io.swagger.annotations.Authorization;
-import io.swagger.annotations.Extension;
-import io.swagger.annotations.ExtensionProperty;
-import io.swagger.annotations.ResponseHeader;
import java.time.Instant;
import java.util.List;
import java.util.Map;
import org.onap.policy.models.pdp.concepts.PdpStatistics;
import org.onap.policy.pap.main.service.PdpStatisticsService;
import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.GetMapping;
-import org.springframework.web.bind.annotation.PathVariable;
-import org.springframework.web.bind.annotation.RequestHeader;
-import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
/**
* @author Ram Krishna Verma (ram.krishna.verma@est.tech)
*/
@RestController
-@RequestMapping(path = "/policy/pap/v1")
@RequiredArgsConstructor
-public class StatisticsRestControllerV1 extends PapRestControllerV1 {
+public class StatisticsRestControllerV1 extends PapRestControllerV1
+ implements StatisticsRestControllerV1Api {
private final PdpStatisticsService pdpStatisticsService;
*
* @return a response
*/
- @GetMapping("statistics")
- @ApiOperation(value = "Fetch current statistics",
- notes = "Returns current statistics of the Policy Administration component",
- response = StatisticsReport.class, authorizations = @Authorization(value = AUTHORIZATION_TYPE))
- @ApiResponses(value = {
- @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
- @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
- @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)})
- public ResponseEntity<StatisticsReport> statistics(
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
- required = false,
- value = REQUEST_ID_NAME) final UUID requestId) {
+ @Override
+ public ResponseEntity<StatisticsReport> statistics(UUID requestId) {
return addLoggingHeaders(addVersionControlHeaders(ResponseEntity.ok()), requestId)
.body(pdpStatisticsService.fetchCurrentStatistics());
}
*
* @return a response
*/
- @GetMapping("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 = {"PDP Statistics"},
- authorizations = @Authorization(value = AUTHORIZATION_TYPE),
- responseHeaders = {
- @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
- response = UUID.class)},
- extensions = {
- @Extension(name = EXTENSION_NAME,
- properties = {
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
- @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
- })
- })
-
- @ApiResponses(value = {
- @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
- @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
- @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
- })
+ @Override
public ResponseEntity<Map<String, Map<String, List<PdpStatistics>>>> pdpStatistics(
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
- required = false,
- value = REQUEST_ID_NAME) final UUID requestId,
- @ApiParam(value = "Record Count") @RequestParam(
- defaultValue = "10", required = false,
- value = "recordCount") final int recordCount,
- @ApiParam(value = "Start time in epoch timestamp") @RequestParam(
- required = false,
- value = "startTime") final Long startTime,
- @ApiParam(value = "End time in epoch timestamp") @RequestParam(
- required = false,
- value = "endTime") final Long endTime) {
+ UUID requestId,
+ Integer recordCount,
+ Long startTime,
+ Long endTime) {
return addLoggingHeaders(addVersionControlHeaders(ResponseEntity.ok()), requestId).body(pdpStatisticsService
- .fetchDatabaseStatistics(recordCount, convertEpochtoInstant(startTime), convertEpochtoInstant(endTime)));
+ .fetchDatabaseStatistics(recordCount.intValue(), convertEpochtoInstant(startTime),
+ convertEpochtoInstant(endTime)));
}
+
/**
* get all statistics of a PDP group.
*
* @param groupName name of the PDP group
* @return a response
*/
- @GetMapping("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 = {"PDP Statistics"},
- authorizations = @Authorization(value = AUTHORIZATION_TYPE),
- responseHeaders = {
- @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
- response = UUID.class)},
- extensions = {
- @Extension(name = EXTENSION_NAME,
- properties = {
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
- @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
- })
- })
- @ApiResponses(value = {
- @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
- @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
- @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
- })
+ @Override
public ResponseEntity<Map<String, Map<String, List<PdpStatistics>>>> pdpGroupStatistics(
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
- required = false,
- value = REQUEST_ID_NAME) final UUID requestId,
- @ApiParam(value = "PDP Group Name") @PathVariable("group") final String groupName,
- @ApiParam(value = "Record Count") @RequestParam(
- defaultValue = "10", required = false,
- value = "recordCount") final int recordCount,
- @ApiParam(value = "Start time in epoch timestamp") @RequestParam(
- required = false,
- value = "startTime") final Long startTime,
- @ApiParam(value = "End time in epoch timestamp") @RequestParam(
- required = false,
- value = "endTime") final Long endTime) {
+ String groupName,
+ UUID requestId,
+ Integer recordCount,
+ Long startTime,
+ Long endTime) {
return addLoggingHeaders(addVersionControlHeaders(ResponseEntity.ok()), requestId)
- .body(pdpStatisticsService.fetchDatabaseStatistics(groupName, recordCount, convertEpochtoInstant(startTime),
- convertEpochtoInstant(endTime)));
+ .body(pdpStatisticsService.fetchDatabaseStatistics(groupName, recordCount.intValue(),
+ convertEpochtoInstant(startTime), convertEpochtoInstant(endTime)));
}
/**
* @param subType type of the sub PDP group
* @return a response
*/
- @GetMapping("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 = {"PDP Statistics"},
- authorizations = @Authorization(value = AUTHORIZATION_TYPE),
- responseHeaders = {
- @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
- response = UUID.class)},
- extensions = {
- @Extension(name = EXTENSION_NAME,
- properties = {
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
- @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
- })
- })
- @ApiResponses(value = {
- @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
- @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
- @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
- })
+ @Override
public ResponseEntity<Map<String, Map<String, List<PdpStatistics>>>> pdpSubGroupStatistics(
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
- required = false,
- value = REQUEST_ID_NAME) final UUID requestId,
- @ApiParam(value = "PDP Group Name") @PathVariable("group") final String groupName,
- @ApiParam(value = "PDP SubGroup type") @PathVariable("type") final String subType,
- @ApiParam(value = "Record Count") @RequestParam(
- defaultValue = "10", required = false,
- value = "recordCount") final int recordCount,
- @ApiParam(value = "Start time in epoch timestamp") @RequestParam(
- required = false,
- value = "startTime") final Long startTime,
- @ApiParam(value = "End time in epoch timestamp") @RequestParam(
- required = false,
- value = "endTime") final Long endTime) {
+ String groupName,
+ String subType,
+ UUID requestId,
+ Integer recordCount,
+ Long startTime,
+ Long endTime) {
return addLoggingHeaders(addVersionControlHeaders(ResponseEntity.ok()), requestId)
- .body(pdpStatisticsService.fetchDatabaseStatistics(groupName, subType, recordCount,
+ .body(pdpStatisticsService.fetchDatabaseStatistics(groupName, subType, recordCount.intValue(),
convertEpochtoInstant(startTime), convertEpochtoInstant(endTime)));
}
* @param recordCount the count of the query response, optional, default return all statistics stored
* @return a response
*/
- @GetMapping("pdps/statistics/{group}/{type}/{pdp}")
- @ApiOperation(value = "Fetch statistics for the specified pdp",
- notes = "Returns statistics for the specified pdp of the Policy Administration component",
- response = Map.class,
- tags = {"PDP Statistics"},
- authorizations = @Authorization(value = AUTHORIZATION_TYPE),
- responseHeaders = {
- @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
- response = String.class),
- @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
- response = UUID.class)},
- extensions = {
- @Extension(name = EXTENSION_NAME,
- properties = {
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
- @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
- })
- })
- @ApiResponses(value = {
- @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
- @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
- @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
- })
+ @Override
public ResponseEntity<Map<String, Map<String, List<PdpStatistics>>>> pdpInstanceStatistics(
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) @RequestHeader(
- required = false,
- value = REQUEST_ID_NAME) final UUID requestId,
- @ApiParam(value = "PDP Group Name") @PathVariable("group") final String groupName,
- @ApiParam(value = "PDP SubGroup type") @PathVariable("type") final String subType,
- @ApiParam(value = "PDP Instance name") @PathVariable("pdp") final String pdpName,
- @ApiParam(value = "Record Count") @RequestParam(
- defaultValue = "10", required = false,
- value = "recordCount") final int recordCount,
- @ApiParam(value = "Start time in epoch timestamp") @RequestParam(
- required = false,
- value = "startTime") final Long startTime,
- @ApiParam(value = "End time in epoch timestamp") @RequestParam(
- required = false,
- value = "endTime") final Long endTime) {
+ String groupName,
+ String subType,
+ String pdpName,
+ UUID requestId,
+ Integer recordCount,
+ Long startTime,
+ Long endTime) {
return addLoggingHeaders(addVersionControlHeaders(ResponseEntity.ok()), requestId)
- .body(pdpStatisticsService.fetchDatabaseStatistics(groupName, subType, pdpName, recordCount,
+ .body(pdpStatisticsService.fetchDatabaseStatistics(groupName, subType, pdpName, recordCount.intValue(),
convertEpochtoInstant(startTime), convertEpochtoInstant(endTime)));
}
private Instant convertEpochtoInstant(Long epochSecond) {
return (epochSecond == null ? null : Instant.ofEpochSecond(epochSecond));
}
+
}
server:
port: 6969
-
+ servlet:
+ context-path: /policy/pap/v1
pap:
name: PapGroup
aaf: false
+# ============LICENSE_START=======================================================
+# Copyright (C) 2022-2023 Nordix Foundation
+# ================================================================================
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# ============LICENSE_END=========================================================
openapi: 3.0.3
info:
- title: Api Documentation
- description: Api Documentation
+ title: Policy Administration Documentation
+ description: Policy Administration is responsible for the deployment life cycle of policies as well as
+ interworking with the mechanisms required to orchestrate the nodes and containers on which
+ policies run. It is also responsible for the administration of policies at run time;
+ ensuring that policies are available to users, that policies are executing correctly,
+ and that the state and status of policies is monitored
termsOfService: urn:tos
- contact: {}
+ contact:
+ name: ONAP Support
+ url: https://lists.onap.org/g/onap-discuss
+ email: onap-discuss@lists.onap.org
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0
version: '1.0'
+externalDocs:
+ description: Policy Framework Documentation
+ url: https://docs.onap.org/projects/onap-policy-parent/en/latest
servers:
- - url: http://localhost:30442
- description: Inferred Url
+ - url: https://{server}
+ variables:
+ server:
+ default: policy/pap/v1
+ description: This value is assigned by the service provider
tags:
- - name: pdp-group-controller
- description: Pdp Group Controller
+ - name: HealthCheckRestControllerV1
+ - name: PdpGroupCreateOrUpdateControllerV1
+ - name: PdpGroupDeleteControllerV1
+ - name: PdpGroupDeployControllerV1
+ - name: PdpGroupHealthCheckControllerV1
+ - name: PdpGroupQueryControllerV1
+ - name: PdpGroupStateChangeControllerV1
+ - name: PolicyAuditControllerV1
+ - name: PolicyComponentsHealthCheckControllerV1
+ - name: PolicyStatusControllerV1
+ - name: StatisticsRestControllerV1
paths:
- /policy/pap/v1/healthcheck:
+ /healthcheck:
get:
tags:
- - pdp-group-controller
+ - HealthCheckRestControllerV1
summary: Perform healthcheck
description: Returns healthy status of the Policy Administration component
operationId: healthcheck
description: Internal Server Error
security:
- basicAuth: []
- /policy/pap/v1/pdps/healthcheck:
+ /pdps/healthcheck:
get:
tags:
- - pdp-group-controller
+ - PdpGroupHealthCheckControllerV1
summary: Returns health status of all PDPs registered with PAP
description: Queries health status of all PDPs, returning all pdps health status
operationId: pdpGroupHealthCheck
x-interface info:
api-version: 1.0.0
last-mod-release: Dublin
- /policy/pap/v1/pdps/groups/batch:
+ /pdps/groups/batch:
post:
tags:
- - pdp-group-controller
+ - PdpGroupCreateOrUpdateControllerV1
summary: Create or update PDP Groups
description: >-
Create or update one or more PDP Groups, returning optional error
x-interface info:
api-version: 1.0.0
last-mod-release: Dublin
- /policy/pap/v1/pdps/groups/{name}:
+ /pdps/groups/{name}:
put:
tags:
- - pdp-group-controller
+ - PdpGroupStateChangeControllerV1
summary: Change state of a PDP Group
description: Changes state of PDP Group, returning optional error details
operationId: changeGroupState
last-mod-release: Dublin
delete:
tags:
- - pdp-group-controller
+ - PdpGroupDeleteControllerV1
summary: Delete PDP Group
description: Deletes a PDP Group, returning optional error details
operationId: deleteGroup
x-interface info:
api-version: 1.0.0
last-mod-release: Dublin
- /policy/pap/v1/pdps/policies/{name}:
+ /pdps/policies/{name}:
delete:
tags:
- - pdp-group-controller
+ - PdpGroupDeleteControllerV1
summary: Undeploy a PDP Policy from PDPs
description: >-
Undeploys the latest version of a policy from the PDPs, returning
x-interface info:
api-version: 1.0.0
last-mod-release: Dublin
- /policy/pap/v1/pdps/policies/{name}/versions/{version}:
+ /pdps/policies/{name}/versions/{version}:
delete:
tags:
- - pdp-group-controller
+ - PdpGroupDeleteControllerV1
summary: Undeploy version of a PDP Policy from PDPs
description: >-
Undeploys a specific version of a policy from the PDPs, returning
x-interface info:
api-version: 1.0.0
last-mod-release: Dublin
- /policy/pap/v1/pdps/deployments/batch:
+ /pdps/deployments/batch:
post:
tags:
- - pdp-group-controller
+ - PdpGroupDeployControllerV1
summary: Updates policy deployments within specific PDP groups
description: >-
Updates policy deployments within specific PDP groups, returning
x-interface info:
api-version: 1.0.0
last-mod-release: Dublin
- /policy/pap/v1/pdps/policies:
+ /pdps/policies:
post:
tags:
- - pdp-group-controller
+ - PdpGroupDeployControllerV1
summary: Deploy or update PDP Policies
description: Deploys or updates PDP Policies, returning optional error details
operationId: deployPolicies
x-interface info:
api-version: 1.0.0
last-mod-release: Dublin
- /policy/pap/v1/pdps:
+ /pdps:
get:
tags:
- - pdp-group-controller
+ - PdpGroupQueryControllerV1
summary: Query details of all PDP groups
description: Queries details of all PDP groups, returning all group details
operationId: queryGroupDetails
x-interface info:
api-version: 1.0.0
last-mod-release: Dublin
- /policy/pap/v1/policies/audit:
+ /policies/audit:
get:
tags:
- - pdp-group-controller
+ - PolicyAuditControllerV1
summary: Queries audit information for all the policies
description: >-
Queries audit information for all the policies, returning audit
style: form
schema:
type: integer
+ minimum: 1
+ maximum: 100
format: int32
+ default: 10
- name: startTime
in: query
description: Start time in epoch timestamp
x-interface info:
api-version: 1.0.0
last-mod-release: Dublin
- /policy/pap/v1/policies/audit/{pdpGroupName}:
+ /policies/audit/{pdpGroupName}:
get:
tags:
- - pdp-group-controller
+ - PolicyAuditControllerV1
summary: Queries audit information for all the policies in a PdpGroup
description: >-
Queries audit information for all the policies in a PdpGroup, returning
style: form
schema:
type: integer
+ minimum: 1
+ maximum: 100
format: int32
+ default: 10
- name: startTime
in: query
description: Start time in epoch timestamp
content:
application/json:
schema:
- type: array
- items:
- $ref: '#/components/schemas/PolicyAudit'
+ type: object
application/yaml:
schema:
- type: array
- items:
- $ref: '#/components/schemas/PolicyAudit'
+ type: object
401:
description: Authentication Error
headers:
x-interface info:
api-version: 1.0.0
last-mod-release: Dublin
- /policy/pap/v1/policies/audit/{pdpGroupName}/{policyName}/{policyVersion}:
+ /policies/audit/{pdpGroupName}/{policyName}/{policyVersion}:
get:
tags:
- - pdp-group-controller
+ - PolicyAuditControllerV1
summary: >-
Queries audit information for a specific version of a policy in a
PdpGroup
style: form
schema:
type: integer
+ minimum: 1
+ maximum: 100
format: int32
+ default: 10
- name: startTime
in: query
description: Start time in epoch timestamp
content:
application/json:
schema:
- type: array
- items:
- $ref: '#/components/schemas/PolicyAudit'
+ type: object
application/yaml:
schema:
- type: array
- items:
- $ref: '#/components/schemas/PolicyAudit'
+ type: object
401:
description: Authentication Error
headers:
x-interface info:
api-version: 1.0.0
last-mod-release: Dublin
- /policy/pap/v1/policies/audit/{policyName}/{policyVersion}:
+ /policies/audit/{policyName}/{policyVersion}:
get:
tags:
- - pdp-group-controller
+ - PolicyAuditControllerV1
summary: Queries audit information for a specific version of a policy
description: >-
Queries audit information for a specific version of a policy, returning
style: form
schema:
type: integer
+ minimum: 1
+ maximum: 100
format: int32
+ default: 10
- name: startTime
in: query
description: Start time in epoch timestamp
content:
application/json:
schema:
- type: array
- items:
- $ref: '#/components/schemas/PolicyAudit'
+ type: object
application/yaml:
schema:
- type: array
- items:
- $ref: '#/components/schemas/PolicyAudit'
+ type: object
401:
description: Authentication Error
headers:
x-interface info:
api-version: 1.0.0
last-mod-release: Dublin
- /policy/pap/v1/components/healthcheck:
+ /components/healthcheck:
get:
tags:
- - pdp-group-controller
+ - PolicyComponentsHealthCheckControllerV1
summary: >-
Returns health status of all policy components, including PAP, API,
Distribution, and PDPs
schema:
type: string
additionalProperties:
- $ref: '#/components/schemas/HealthCheckReport'
+ type: object
application/yaml:
schema:
type: string
additionalProperties:
- $ref: '#/components/schemas/HealthCheckReport'
+ type: object
401:
description: Authentication Error
headers:
x-interface info:
api-version: 1.0.0
last-mod-release: Dublin
- /policy/pap/v1/policies/deployed:
+ /policies/deployed:
get:
tags:
- - pdp-group-controller
+ - PolicyStatusControllerV1
summary: Queries status of all deployed policies
description: >-
Queries status of all deployed policies, returning success and failure
content:
application/json:
schema:
- type: array
- items:
- $ref: '#/components/schemas/PolicyStatus'
+ type: object
application/yaml:
schema:
- type: array
- items:
- $ref: '#/components/schemas/PolicyStatus'
+ type: object
401:
description: Authentication Error
headers:
x-interface info:
api-version: 1.0.0
last-mod-release: Dublin
- /policy/pap/v1/policies/deployed/{name}:
+ /policies/deployed/{name}:
get:
tags:
- - pdp-group-controller
+ - PolicyStatusControllerV1
summary: Queries status of specific deployed policies
description: >-
Queries status of specific deployed policies, returning success and
content:
application/json:
schema:
- type: array
- items:
- $ref: '#/components/schemas/PolicyStatus'
+ type: object
application/yaml:
schema:
- type: array
- items:
- $ref: '#/components/schemas/PolicyStatus'
+ type: object
401:
description: Authentication Error
headers:
x-interface info:
api-version: 1.0.0
last-mod-release: Dublin
- /policy/pap/v1/policies/deployed/{name}/{version}:
+ /policies/deployed/{name}/{version}:
get:
tags:
- - pdp-group-controller
+ - PolicyStatusControllerV1
summary: Queries status of a specific deployed policy
description: >-
Queries status of a specific deployed policy, returning success and
content:
application/json:
schema:
- type: array
- items:
- $ref: '#/components/schemas/PolicyStatus'
+ type: object
application/yaml:
schema:
- type: array
- items:
- $ref: '#/components/schemas/PolicyStatus'
+ type: object
401:
description: Authentication Error
headers:
x-interface info:
api-version: 1.0.0
last-mod-release: Dublin
- /policy/pap/v1/policies/status:
+ /policies/status:
get:
tags:
- - pdp-group-controller
+ - PolicyStatusControllerV1
summary: Queries status of policies in all PdpGroups
description: >-
Queries status of policies in all PdpGroups, returning status of
content:
application/json:
schema:
- type: array
- items:
- $ref: '#/components/schemas/PolicyStatus'
+ type: object
application/yaml:
schema:
- type: array
- items:
- $ref: '#/components/schemas/PolicyStatus'
+ type: object
401:
description: Authentication Error
headers:
x-interface info:
api-version: 1.0.0
last-mod-release: Dublin
- /policy/pap/v1/policies/status/{pdpGroupName}:
+ /policies/status/{pdpGroupName}:
get:
tags:
- - pdp-group-controller
+ - PolicyStatusControllerV1
summary: Queries status of policies in a specific PdpGroup
description: >-
Queries status of policies in a specific PdpGroup, returning status of
content:
application/json:
schema:
- type: array
- items:
- $ref: '#/components/schemas/PolicyStatus'
+ type: object
application/yaml:
schema:
- type: array
- items:
- $ref: '#/components/schemas/PolicyStatus'
+ type: object
401:
description: Authentication Error
headers:
x-interface info:
api-version: 1.0.0
last-mod-release: Dublin
- /policy/pap/v1/policies/status/{pdpGroupName}/{policyName}:
+ /policies/status/{pdpGroupName}/{policyName}:
get:
tags:
- - pdp-group-controller
+ - PolicyStatusControllerV1
summary: >-
Queries status of all versions of a specific policy in a specific
PdpGroup
content:
application/json:
schema:
- type: array
- items:
- $ref: '#/components/schemas/PolicyStatus'
+ type: object
application/yaml:
schema:
- type: array
- items:
- $ref: '#/components/schemas/PolicyStatus'
+ type: object
401:
description: Authentication Error
headers:
x-interface info:
api-version: 1.0.0
last-mod-release: Dublin
- /policy/pap/v1/policies/status/{pdpGroupName}/{policyName}/{policyVersion}:
+ /policies/status/{pdpGroupName}/{policyName}/{policyVersion}:
get:
tags:
- - pdp-group-controller
+ - PolicyStatusControllerV1
summary: >-
Queries status of a specific version of a specific policy in a specific
PdpGroup
content:
application/json:
schema:
- type: array
- items:
- $ref: '#/components/schemas/PolicyStatus'
+ type: object
application/yaml:
schema:
- type: array
- items:
- $ref: '#/components/schemas/PolicyStatus'
+ type: object
401:
description: Authentication Error
headers:
- basicAuth: []
x-interface info:
api-version: 1.0.0
- last-mod-release: Dublin
- /policy/pap/v1/pdps/statistics:
+ last-mod-release: Dublin
+ /pdps/statistics:
get:
tags:
- - pdp-group-controller
+ - StatisticsRestControllerV1
summary: Fetch statistics for all PDP Groups and subgroups in the system
description: >-
Returns for all PDP Groups and subgroups statistics of the Policy
schema:
type: integer
format: int32
+ default: 10
- name: startTime
in: query
description: Start time in epoch timestamp
content:
application/json:
schema:
- $ref: '#/components/schemas/PdpStatistics'
+ type: string
+ additionalProperties:
+ type: string
+ additionalProperties:
+ type: array
+ items:
+ $ref: '#/components/schemas/PdpStatistics'
application/yaml:
schema:
- $ref: '#/components/schemas/PdpStatistics'
+ type: string
+ additionalProperties:
+ type: string
+ additionalProperties:
+ type: array
+ items:
+ $ref: '#/components/schemas/PdpStatistics'
401:
description: Authentication Error
headers:
x-interface info:
api-version: 1.0.0
last-mod-release: Dublin
- /policy/pap/v1/pdps/statistics/{group}:
+ /pdps/statistics/{group}:
get:
tags:
- - pdp-group-controller
+ - StatisticsRestControllerV1
summary: Fetch current statistics for given PDP Group
description: >-
Returns statistics for given PDP Group of the Policy Administration
schema:
type: integer
format: int32
+ default: 10
- name: startTime
in: query
description: Start time in epoch timestamp
x-interface info:
api-version: 1.0.0
last-mod-release: Dublin
- /policy/pap/v1/pdps/statistics/{group}/{type}:
+ /pdps/statistics/{group}/{type}:
get:
tags:
- - pdp-group-controller
+ - StatisticsRestControllerV1
summary: Fetch statistics for the specified subgroup
description: >-
Returns statistics for the specified subgroup of the Policy
schema:
type: integer
format: int32
+ default: 10
- name: startTime
in: query
description: Start time in epoch timestamp
content:
application/json:
schema:
- $ref: '#/components/schemas/PdpStatistics'
+ type: string
+ additionalProperties:
+ type: string
+ additionalProperties:
+ type: array
+ items:
+ $ref: '#/components/schemas/PdpStatistics'
application/yaml:
schema:
- $ref: '#/components/schemas/PdpStatistics'
+ type: string
+ additionalProperties:
+ type: string
+ additionalProperties:
+ type: array
+ items:
+ $ref: '#/components/schemas/PdpStatistics'
401:
description: Authentication Error
headers:
x-interface info:
api-version: 1.0.0
last-mod-release: Dublin
- /policy/pap/v1/pdps/statistics/{group}/{type}/{pdp}:
+ /pdps/statistics/{group}/{type}/{pdp}:
get:
tags:
- - pdp-group-controller
+ - StatisticsRestControllerV1
summary: Fetch statistics for the specified pdp
description: >-
Returns statistics for the specified pdp of the Policy Administration
schema:
type: integer
format: int32
+ default: 10
- name: startTime
in: query
description: Start time in epoch timestamp
content:
application/json:
schema:
- $ref: '#/components/schemas/PdpStatistics'
+ type: string
+ additionalProperties:
+ type: string
+ additionalProperties:
+ type: array
+ items:
+ $ref: '#/components/schemas/PdpStatistics'
application/yaml:
schema:
- $ref: '#/components/schemas/PdpStatistics'
+ type: string
+ additionalProperties:
+ type: string
+ additionalProperties:
+ type: array
+ items:
+ $ref: '#/components/schemas/PdpStatistics'
401:
description: Authentication Error
headers:
x-interface info:
api-version: 1.0.0
last-mod-release: Dublin
- /policy/pap/v1/statistics:
+ /statistics:
get:
tags:
- - pdp-group-controller
+ - StatisticsRestControllerV1
summary: Fetch current statistics
description: Returns current statistics of the Policy Administration component
operationId: statistics
type: object
PdpState:
title: PdpState
- type: string
+ type: object
PdpGroupUpdateResponse:
title: PdpGroupUpdateResponse
type: object
* @throws Exception if an error occurs
*/
protected void testSwagger(final String endpoint) throws Exception {
- final Invocation.Builder invocationBuilder =
- sendFqeRequest(httpsPrefix + "v3/api-docs", true, MediaType.APPLICATION_JSON);
+ final Invocation.Builder invocationBuilder = sendFqeRequest(httpsPrefix
+ + ENDPOINT_PREFIX + "v3/api-docs", true, MediaType.APPLICATION_JSON);
final String resp = invocationBuilder.get(String.class);
- assertTrue(resp.contains(ENDPOINT_PREFIX + endpoint));
+ assertTrue(resp.contains(endpoint));
}
/**
implicit-strategy: org.onap.policy.common.spring.utils.CustomImplicitNamingStrategy
server:
port: 6969
+ servlet:
+ context-path: /policy/pap/v1
pap:
name: "PapGroupE2E"
server:
port: 6969
-
+ servlet:
+ context-path: /policy/pap/v1
pap:
name: "PapGroup"
aaf: false
Code Review / policy / pap.git / commitdiff