Merge "Add description to parameters in the remaining controllers"

diff --combined policy-agent/src/main/java/org/oransc/policyagent/controllers/PolicyController.java
index b75d320,7cc042c..d2ae0e0
--- 1/policy-agent/src/main/java/org/oransc/policyagent/controllers/PolicyController.java
--- 2/policy-agent/src/main/java/org/oransc/policyagent/controllers/PolicyController.java
+++ b/policy-agent/src/main/java/org/oransc/policyagent/controllers/PolicyController.java
@@@ -99,8 -99,9 +99,9 @@@ public class PolicyController 
          value = {
              @ApiResponse(code = 200, message = "Policy schemas", response = Object.class, responseContainer = "List"), //
              @ApiResponse(code = 404, message = "RIC is not found", response = String.class)})
-     public ResponseEntity<String> getPolicySchemas(@ApiParam(name = "ric", required = false, value = "The name of " +//
-         "the Near-RT RIC to get the definitions for.")@RequestParam(name = "ric", required = false) String ricName) {
+     public ResponseEntity<String> getPolicySchemas( //
+         @ApiParam(name = "ric", required = false, value = "The name of the Near-RT RIC to get the definitions for.") //
+         @RequestParam(name = "ric", required = false) String ricName) {
          if (ricName == null) {
              Collection<PolicyType> types = this.policyTypes.getAll();
              return new ResponseEntity<>(toPolicyTypeSchemasJson(types), HttpStatus.OK);
@@@ -120,8 -121,9 +121,9 @@@
          value = { //
              @ApiResponse(code = 200, message = "Policy schema", response = Object.class),
              @ApiResponse(code = 404, message = "RIC is not found", response = String.class)})
-     public ResponseEntity<String> getPolicySchema(@ApiParam(name = "id", required = true, value = "The ID of the " +//
-         "policy type to get the definition for.")@RequestParam(name = "id", required = true) String id) {
+     public ResponseEntity<String> getPolicySchema( //
+         @ApiParam(name = "id", required = true, value = "The ID of the policy type to get the definition for.") //
+         @RequestParam(name = "id", required = true) String id) {
          try {
              PolicyType type = policyTypes.getType(id);
              return new ResponseEntity<>(type.schema(), HttpStatus.OK);
@@@ -140,8 -142,9 +142,9 @@@
                  response = String.class,
                  responseContainer = "List"),
              @ApiResponse(code = 404, message = "RIC is not found", response = String.class)})
-     public ResponseEntity<String> getPolicyTypes(@ApiParam(name = "ric", required = false, value = "The name of " +//
-         "the Near-RT RIC to get types for.")@RequestParam(name = "ric", required = false) String ricName) {
+     public ResponseEntity<String> getPolicyTypes( //
+         @ApiParam(name = "ric", required = false, value = "The name of the Near-RT RIC to get types for.") //
+         @RequestParam(name = "ric", required = false) String ricName) {
          if (ricName == null) {
              Collection<PolicyType> types = this.policyTypes.getAll();
              return new ResponseEntity<>(toPolicyTypeIdsJson(types), HttpStatus.OK);
@@@ -163,8 -166,8 +166,8 @@@
              @ApiResponse(code = 404, message = "Policy is not found")} //
      )
      public ResponseEntity<String> getPolicy( //
-         @ApiParam(name = "id", required = true, value = "The ID of the policy instance.")@RequestParam(name = "id", //
-             required = true) String id) {
+         @ApiParam(name = "id", required = true, value = "The ID of the policy instance.") //
+         @RequestParam(name = "id", required = true) String id) {
          try {
              Policy p = policies.getPolicy(id);
              return new ResponseEntity<>(p.json(), HttpStatus.OK);
@@@ -181,8 -184,8 +184,8 @@@
              @ApiResponse(code = 404, message = "Policy is not found", response = String.class),
              @ApiResponse(code = 423, message = "RIC is not operational", response = String.class)})
      public Mono<ResponseEntity<Object>> deletePolicy( //
-         @ApiParam(name = "id", required = true, value = "The ID of the policy instance.")@RequestParam(name = "id", //
-             required = true) String id) {
+         @ApiParam(name = "id", required = true, value = "The ID of the policy instance.") //
+         @RequestParam(name = "id", required = true) String id) {
          try {
              Policy policy = policies.getPolicy(id);
              keepServiceAlive(policy.ownerServiceName());
@@@ -212,17 -215,18 +215,18 @@@
          })
      public Mono<ResponseEntity<Object>> putPolicy( //
          @ApiParam(name = "type", required = false, value = "The name of the policy type.") //
-             @RequestParam(name = "type", required = false, defaultValue = "") String typeName, //
-         @ApiParam(name = "id", required = true, value = "The ID of the policy instance.")@RequestParam(name = "id", //
-             required = true) String instanceId, //
-         @ApiParam(name = "ric", required = true, value = "The name of the Near-RT RIC where the policy will be " +//
-             "created.")@RequestParam(name = "ric", required = true) String ricName, //
+         @RequestParam(name = "type", required = false, defaultValue = "") String typeName, //
+         @ApiParam(name = "id", required = true, value = "The ID of the policy instance.") //
+         @RequestParam(name = "id", required = true) String instanceId, //
+         @ApiParam(name = "ric", required = true, value = "The name of the Near-RT RIC where the policy will be " + //
+             "created.") //
+         @RequestParam(name = "ric", required = true) String ricName, //
          @ApiParam(name = "service", required = true, value = "The name of the service creating the policy.") //
-             @RequestParam(name = "service", required = true) String service, //
-         @ApiParam(name = "transient", required = false, value = "If the policy is transient or not (boolean " +//
-             "defaulted to false). A policy is transient if it will be forgotten when the service needs to " +//
-             "reconnect to the Near-RT RIC.")@RequestParam(name = "transient", required = false, //
-             defaultValue = "false") boolean isTransient, //
+         @RequestParam(name = "service", required = true) String service, //
+         @ApiParam(name = "transient", required = false, value = "If the policy is transient or not (boolean " + //
+             "defaulted to false). A policy is transient if it will be forgotten when the service needs to " + //
+             "reconnect to the Near-RT RIC.") //
+         @RequestParam(name = "transient", required = false, defaultValue = "false") boolean isTransient, //
          @RequestBody Object jsonBody) {
  
          String jsonString = gson.toJson(jsonBody);
@@@ -282,7 -286,6 +286,7 @@@
              RejectionException e = new RejectionException("Policy cannot change RIC, policyId: " + current.id() + //
                  ", RIC name: " + current.ric().name() + //
                  ", new name: " + policy.ric().name(), HttpStatus.CONFLICT);
 +            logger.debug("Request rejected, {}", e.getMessage());
              return Mono.error(e);
          }
          return Mono.just("OK");
@@@ -290,7 -293,6 +294,7 @@@
  
      private Mono<Object> checkSupportedType(Ric ric, PolicyType type) {
          if (!ric.isSupportingType(type.name())) {
 +            logger.debug("Request rejected, type not supported, RIC: {}", ric);
              RejectionException e = new RejectionException(
                  "Type: " + type.name() + " not supported by RIC: " + ric.name(), HttpStatus.NOT_FOUND);
              return Mono.error(e);
@@@ -302,7 -304,6 +306,7 @@@
          if (ric.getState() == Ric.RicState.AVAILABLE) {
              return Mono.just("OK");
          } else {
 +            logger.debug("Request rejected RIC not IDLE, ric: {}", ric);
              RejectionException e = new RejectionException(
                  "Ric is not operational, RIC name: " + ric.name() + ", state: " + ric.getState(), HttpStatus.LOCKED);
              return Mono.error(e);
@@@ -317,11 -318,11 +321,11 @@@
              @ApiResponse(code = 404, message = "RIC or type not found", response = String.class)})
      public ResponseEntity<String> getPolicies( //
          @ApiParam(name = "type", required = false, value = "The name of the policy type to get policies for.") //
-             @RequestParam(name = "type", required = false) String type, //
+         @RequestParam(name = "type", required = false) String type, //
          @ApiParam(name = "ric", required = false, value = "The name of the Near-RT RIC to get policies for.") //
-             @RequestParam(name = "ric", required = false) String ric, //
+         @RequestParam(name = "ric", required = false) String ric, //
          @ApiParam(name = "service", required = false, value = "The name of the service to get policies for.") //
-             @RequestParam(name = "service", required = false) String service) //
+         @RequestParam(name = "service", required = false) String service) //
      {
          if ((type != null && this.policyTypes.get(type) == null)) {
              return new ResponseEntity<>("Policy type not found", HttpStatus.NOT_FOUND);
@@@ -341,11 -342,11 +345,11 @@@
              @ApiResponse(code = 404, message = "RIC or type not found", response = String.class)})
      public ResponseEntity<String> getPolicyIds( //
          @ApiParam(name = "type", required = false, value = "The name of the policy type to get policies for.") //
-             @RequestParam(name = "type", required = false) String type, //
+         @RequestParam(name = "type", required = false) String type, //
          @ApiParam(name = "ric", required = false, value = "The name of the Near-RT RIC to get policies for.") //
-             @RequestParam(name = "ric", required = false) String ric, //
+         @RequestParam(name = "ric", required = false) String ric, //
          @ApiParam(name = "service", required = false, value = "The name of the service to get policies for.") //
-             @RequestParam(name = "service", required = false) String service) //
+         @RequestParam(name = "service", required = false) String service) //
      {
          if ((type != null && this.policyTypes.get(type) == null)) {
              return new ResponseEntity<>("Policy type not found", HttpStatus.NOT_FOUND);
@@@ -366,7 -367,8 +370,8 @@@
              @ApiResponse(code = 404, message = "Policy is not found", response = String.class)} //
      )
      public Mono<ResponseEntity<String>> getPolicyStatus( //
-         @ApiParam(name = "id", required = true, value = "The ID of the policy.")@RequestParam(name = "id", //
+         @ApiParam(name = "id", required = true, value = "The ID of the policy.") @RequestParam(
+             name = "id", //
              required = true) String id) {
          try {
              Policy policy = policies.getPolicy(id);