import io.swagger.annotations.ResponseHeader;\r
import io.swagger.annotations.SecurityDefinition;\r
import io.swagger.annotations.SwaggerDefinition;\r
-\r
import java.util.UUID;\r
-\r
import javax.ws.rs.Consumes;\r
import javax.ws.rs.DELETE;\r
import javax.ws.rs.DefaultValue;\r
import javax.ws.rs.Produces;\r
import javax.ws.rs.QueryParam;\r
import javax.ws.rs.core.Response;\r
-\r
import org.onap.policy.api.main.rest.provider.HealthCheckProvider;\r
import org.onap.policy.api.main.rest.provider.PolicyProvider;\r
import org.onap.policy.api.main.rest.provider.PolicyTypeProvider;\r
response = String.class),\r
@ResponseHeader(name = "X-ONAP-RequestID",\r
description = "Used to track REST transactions for logging purpose", response = UUID.class)},\r
- authorizations = @Authorization(value = "basicAuth"), tags = {"HealthCheck",},\r
+ authorizations = @Authorization(value = "basicAuth"), tags = {"HealthCheck", },\r
extensions = {\r
@Extension(name = "interface info", properties = {@ExtensionProperty(name = "api-version", value = "1.0.0"),\r
@ExtensionProperty(name = "last-mod-release", value = "Dublin")})})\r
response = String.class),\r
@ResponseHeader(name = "X-ONAP-RequestID",\r
description = "Used to track REST transactions for logging purpose", response = UUID.class)},\r
- authorizations = @Authorization(value = "basicAuth"), tags = {"Statistics",},\r
+ authorizations = @Authorization(value = "basicAuth"), tags = {"Statistics", },\r
extensions = {\r
@Extension(name = "interface info", properties = {@ExtensionProperty(name = "api-version", value = "1.0.0"),\r
@ExtensionProperty(name = "last-mod-release", value = "Dublin")})})\r
response = String.class),\r
@ResponseHeader(name = "X-ONAP-RequestID",\r
description = "Used to track REST transactions for logging purpose", response = UUID.class)},\r
- authorizations = @Authorization(value = "basicAuth"), tags = {"PolicyType",},\r
+ authorizations = @Authorization(value = "basicAuth"), tags = {"PolicyType", },\r
extensions = {\r
@Extension(name = "interface info", properties = {@ExtensionProperty(name = "api-version", value = "1.0.0"),\r
@ExtensionProperty(name = "last-mod-release", value = "Dublin")})})\r
response = String.class),\r
@ResponseHeader(name = "X-ONAP-RequestID",\r
description = "Used to track REST transactions for logging purpose", response = UUID.class)},\r
- authorizations = @Authorization(value = "basicAuth"), tags = {"PolicyType",},\r
+ authorizations = @Authorization(value = "basicAuth"), tags = {"PolicyType", },\r
extensions = {\r
@Extension(name = "interface info", properties = {@ExtensionProperty(name = "api-version", value = "1.0.0"),\r
@ExtensionProperty(name = "last-mod-release", value = "Dublin")})})\r
response = String.class),\r
@ResponseHeader(name = "X-ONAP-RequestID",\r
description = "Used to track REST transactions for logging purpose", response = UUID.class)},\r
- authorizations = @Authorization(value = "basicAuth"), tags = {"PolicyType",},\r
+ authorizations = @Authorization(value = "basicAuth"), tags = {"PolicyType", },\r
extensions = {\r
@Extension(name = "interface info", properties = {@ExtensionProperty(name = "api-version", value = "1.0.0"),\r
@ExtensionProperty(name = "last-mod-release", value = "Dublin")})})\r
response = String.class),\r
@ResponseHeader(name = "X-ONAP-RequestID",\r
description = "Used to track REST transactions for logging purpose", response = UUID.class)},\r
- authorizations = @Authorization(value = "basicAuth"), tags = {"PolicyType",},\r
+ authorizations = @Authorization(value = "basicAuth"), tags = {"PolicyType", },\r
extensions = {\r
@Extension(name = "interface info", properties = {@ExtensionProperty(name = "api-version", value = "1.0.0"),\r
@ExtensionProperty(name = "last-mod-release", value = "Dublin")})})\r
@POST\r
@Path("/policytypes")\r
@ApiOperation(value = "Create a new policy type", notes = "Client should provide TOSCA body of the new policy type",\r
- authorizations = @Authorization(value = "basicAuth"), tags = {"PolicyType",},\r
+ authorizations = @Authorization(value = "basicAuth"), tags = {"PolicyType", },\r
response = ToscaServiceTemplate.class,\r
responseHeaders = {\r
@ResponseHeader(name = "X-MinorVersion",\r
notes = "Rule 1: pre-defined policy types cannot be deleted;"\r
+ "Rule 2: policy types that are in use (parameterized by a TOSCA policy) cannot be deleted."\r
+ "The parameterizing TOSCA policies must be deleted first;",\r
- authorizations = @Authorization(value = "basicAuth"), tags = {"PolicyType",},\r
+ authorizations = @Authorization(value = "basicAuth"), tags = {"PolicyType", },\r
response = ToscaServiceTemplate.class,\r
responseHeaders = {\r
@ResponseHeader(name = "X-MinorVersion",\r
response = String.class),\r
@ResponseHeader(name = "X-ONAP-RequestID",\r
description = "Used to track REST transactions for logging purpose", response = UUID.class)},\r
- authorizations = @Authorization(value = "basicAuth"), tags = {"Policy",},\r
+ authorizations = @Authorization(value = "basicAuth"), tags = {"Policy", },\r
extensions = {\r
@Extension(name = "interface info", properties = {\r
@ExtensionProperty(name = "api-version", value = "1.0.0"),\r
response = String.class),\r
@ResponseHeader(name = "X-ONAP-RequestID",\r
description = "Used to track REST transactions for logging purpose", response = UUID.class)},\r
- authorizations = @Authorization(value = "basicAuth"), tags = {"Policy",},\r
+ authorizations = @Authorization(value = "basicAuth"), tags = {"Policy", },\r
extensions = {\r
@Extension(name = "interface info", properties = {\r
@ExtensionProperty(name = "api-version", value = "1.0.0"),\r
response = String.class),\r
@ResponseHeader(name = "X-ONAP-RequestID",\r
description = "Used to track REST transactions for logging purpose", response = UUID.class)},\r
- authorizations = @Authorization(value = "basicAuth"), tags = {"Policy",},\r
+ authorizations = @Authorization(value = "basicAuth"), tags = {"Policy", },\r
extensions = {\r
@Extension(name = "interface info", properties = {@ExtensionProperty(name = "api-version", value = "1.0.0"),\r
@ExtensionProperty(name = "last-mod-release", value = "Dublin")})})\r
@Path("/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies")\r
@ApiOperation(value = "Create a new policy for a policy type version",\r
notes = "Client should provide TOSCA body of the new policy",\r
- authorizations = @Authorization(value = "basicAuth"), tags = {"Policy",}, response = ToscaServiceTemplate.class,\r
+ authorizations = @Authorization(value = "basicAuth"), tags = {"Policy", },\r
+ response = ToscaServiceTemplate.class,\r
responseHeaders = {\r
@ResponseHeader(name = "X-MinorVersion",\r
description = "Used to request or communicate a MINOR version back from the client"\r
@Path("/policies")\r
@ApiOperation(value = "Create one or more new policies",\r
notes = "Client should provide TOSCA body of the new polic(ies)",\r
- authorizations = @Authorization(value = "basicAuth"), tags = {"Policy",}, response = ToscaServiceTemplate.class,\r
+ authorizations = @Authorization(value = "basicAuth"), tags = {"Policy", },\r
+ response = ToscaServiceTemplate.class,\r
responseHeaders = {\r
@ResponseHeader(name = "X-MinorVersion",\r
description = "Used to request or communicate a MINOR version back from the client"\r
@Path("/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}/versions/{policyVersion}")\r
@ApiOperation(value = "Delete a particular version of a policy",\r
notes = "Rule: the version that has been deployed in PDP group(s) cannot be deleted",\r
- authorizations = @Authorization(value = "basicAuth"), tags = {"Policy",}, response = ToscaServiceTemplate.class,\r
+ authorizations = @Authorization(value = "basicAuth"), tags = {"Policy", },\r
+ response = ToscaServiceTemplate.class,\r
responseHeaders = {\r
@ResponseHeader(name = "X-MinorVersion",\r
description = "Used to request or communicate a MINOR version back from the client"\r
description = "Used only to communicate an API's latest version", response = String.class),
@ResponseHeader(name = "X-ONAP-RequestID",
description = "Used to track REST transactions for logging purpose", response = UUID.class)},
- authorizations = @Authorization(value = "basicAuth"), tags = {"Legacy Operational Policy",},
+ authorizations = @Authorization(value = "basicAuth"), tags = {"Legacy Operational Policy", },
extensions = {@Extension(name = "interface info",
properties = {@ExtensionProperty(name = "api-version", value = "1.0.0"),
@ExtensionProperty(name = "last-mod-release", value = "Dublin")})})
description = "Used only to communicate an API's latest version", response = String.class),
@ResponseHeader(name = "X-ONAP-RequestID",
description = "Used to track REST transactions for logging purpose", response = UUID.class)},
- authorizations = @Authorization(value = "basicAuth"), tags = {"Legacy Operational Policy",},
+ authorizations = @Authorization(value = "basicAuth"), tags = {"Legacy Operational Policy", },
extensions = {@Extension(name = "interface info",
properties = {@ExtensionProperty(name = "api-version", value = "1.0.0"),
@ExtensionProperty(name = "last-mod-release", value = "Dublin")})})
description = "Used only to communicate an API's latest version", response = String.class),
@ResponseHeader(name = "X-ONAP-RequestID",
description = "Used to track REST transactions for logging purpose", response = UUID.class)},
- authorizations = @Authorization(value = "basicAuth"), tags = {"Legacy Operational Policy",},
+ authorizations = @Authorization(value = "basicAuth"), tags = {"Legacy Operational Policy", },
extensions = {@Extension(name = "interface info",
properties = {@ExtensionProperty(name = "api-version", value = "1.0.0"),
@ExtensionProperty(name = "last-mod-release", value = "Dublin")})})
@Path("/policytypes/onap.policies.controlloop.Operational/versions/1.0.0/policies")
@ApiOperation(value = "Create a new operational policy",
notes = "Client should provide entity body of the new operational policy",
- authorizations = @Authorization(value = "basicAuth"), tags = {"Legacy Operational Policy",},
+ authorizations = @Authorization(value = "basicAuth"), tags = {"Legacy Operational Policy", },
response = LegacyOperationalPolicy.class,
responseHeaders = {
@ResponseHeader(name = "X-MinorVersion",
+ "policies/{policyId}/versions/{policyVersion}")
@ApiOperation(value = "Delete a particular version of a specified operational policy",
notes = "Rule: the version that has been deployed in PDP group(s) cannot be deleted",
- authorizations = @Authorization(value = "basicAuth"), tags = {"Legacy Operational Policy",},
+ authorizations = @Authorization(value = "basicAuth"), tags = {"Legacy Operational Policy", },
response = LegacyOperationalPolicy.class,
responseHeaders = {
@ResponseHeader(name = "X-MinorVersion",