Merge "Documentation updates"

5 files changed, 13 insertions, 13 deletions

diff --git a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/SwaggerConfig.java b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/SwaggerConfig.java
index b262af07..774b2363 100644
--- a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/SwaggerConfig.java
+++ b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/SwaggerConfig.java
@@ -52,15 +52,15 @@ public class SwaggerConfig {
     private static final String H3 = "<h3>";
     private static final String H3_END = "</h3>";
 
-    public static final String API_TITLE = "A1 Policy management service";
+    public static final String API_TITLE = "A1 Policy Management Service";
     static final String DESCRIPTION = "<h2>General</h2>" + //
-            "<p>The O-RAN Non-RT RIC Policy Management Service provides a REST API for management of A1 policices. <br/>The main tasks of the service are:</p>"
+            "<p>The O-RAN Non-RT RIC Policy Management Service provides a REST API for management of A1 policies. <br/>The main tasks of the service are:</p>"
             + //
             "<ul>" + //
             "<li>A1 Policy creation, modification and deletion.</li>" + //
             "<li>Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs</li>" + //
             "<li>Maintaining a view of supported Near-RT RIC policy types</li>" + //
-            "<li>Supervision of using services (R-APPs). When a service is unavailble, its policies are removed.</li>" + //
+            "<li>Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.</li>" + //
             "</ul>" + //
             "<h2>APIs provided by the service</h2>" + //
             H3 + PolicyController.API_NAME + H3_END + //
@@ -75,14 +75,14 @@ public class SwaggerConfig {
             "<p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.</p>"
             + //
             H3 + Consts.V2_API_SERVICE_CALLBACKS_NAME + H3_END + //
-            "<p>These are endpoints that are invoked by this service. The callbacks are registerred in this service at service registration.</p>"
+            "<p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.</p>"
             + //
             H3 + RicRepositoryController.API_NAME + H3_END + //
             "<p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.</p>"
             + H3 + StatusController.API_NAME + H3_END + //
             "<p>API used for supervision of the PMS component.</p>" + //
             H3 + ServiceController.API_NAME + H3_END + //
-            "<p>API used for registerring services that uses PMS. Each A1 policy is owned by a service. PMS can supervise each registerred service and will automatically remove policies for unavailable services.</p>";
+            "<p>API used for registering services that uses PMS. Each A1 policy is owned by a service. PMS can supervise each registered service and will automatically remove policies for unavailable services.</p>";
 
     public static final String VERSION = "1.1.0";
 }
diff --git a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/PolicyTypeInfo.java b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/PolicyTypeInfo.java
index 7449e94d..b619e44b 100644
--- a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/PolicyTypeInfo.java
+++ b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/PolicyTypeInfo.java
@@ -33,7 +33,7 @@ import org.immutables.gson.Gson;
 @Schema(name = "policytype_v2", description = "Policy type")
 public class PolicyTypeInfo {
 
-    @Schema(description = "Policy type json scema. The schema is a json object following http://json-schema.org/draft-07/schema")
+    @Schema(description = "Policy type json schema. The schema is a json object following http://json-schema.org/draft-07/schema")
     @SerializedName("policy_schema")
     @JsonProperty("policy_schema")
     public final Object schema;
diff --git a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/RicRepositoryController.java b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/RicRepositoryController.java
index def388ac..9e2644ad 100644
--- a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/RicRepositoryController.java
+++ b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/RicRepositoryController.java
@@ -68,8 +68,8 @@ public class RicRepositoryController {
 
     private static final String GET_RIC_BRIEF = "Returns info for one Near-RT RIC";
     private static final String GET_RIC_DETAILS =
-            "Either a Near-RT RIC identity or a Mananged Element identity can be specified.<br>" //
-                    + "The intention with Mananged Element identity is the ID used in O1 for accessing the traffical element (such as the ID of CU).";
+            "Either a Near-RT RIC identity or a Managed Element identity can be specified.<br>" //
+                    + "The intention with Managed Element identity is the ID used in O1 for accessing the traffical element (such as the ID of CU).";
 
     /**
      * Example: http://localhost:8081/v2/rics/ric?managed_element_id=kista_1
diff --git a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/ServiceController.java b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/ServiceController.java
index 7f342150..faa152ca 100644
--- a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/ServiceController.java
+++ b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/ServiceController.java
@@ -178,7 +178,7 @@ public class ServiceController {
     }
 
     @Operation(summary = "Heartbeat indicates that the service is running",
-            description = "A registerred service must call this in regular intervals to indicate that it is in operation. Absence of this call will lead to that the service will be deregisterred and all its policies are removed.")
+            description = "A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke this operation before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed. (This timeout can be set or disabled when each service is initially registered)")
     @ApiResponses(value = { //
             @ApiResponse(responseCode = "200", description = "Service supervision timer refreshed, OK"), //
             @ApiResponse(responseCode = "404", description = "The service is not found, needs re-registration",
diff --git a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/ServiceRegistrationInfo.java b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/ServiceRegistrationInfo.java
index 16f1f163..17277c9a 100644
--- a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/ServiceRegistrationInfo.java
+++ b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/ServiceRegistrationInfo.java
@@ -36,11 +36,11 @@ public class ServiceRegistrationInfo {
     @JsonProperty("service_id")
     public String serviceId = "";
 
-    @Schema(description = "keep alive interval for the service. This is a heartbeat supervision of the service, "
-            + "which in regular intevals must invoke a 'keepalive' REST call. "
-            + "When a service does not invoke this call within the given time, it is considered unavailble. "
+    @Schema(description = "keep alive interval for the service. This is used to enable optional heartbeat supervision of the service. "
+            + "If set (> 0) the registered service should regularly invoke a 'keepalive' REST call. "
+            + "When a service fails to invoke this 'keepalive' call within the configured time, the service is considered unavailable. "
             + "An unavailable service will be automatically deregistered and its policies will be deleted. "
-            + "Value 0 means no timeout supervision.")
+            + "Value 0 means timeout supervision is disabled.")
     @SerializedName("keep_alive_interval_seconds")
     @JsonProperty("keep_alive_interval_seconds")
     public long keepAliveIntervalSeconds = 0;