Documentation updates

[ccsdk/oran.git] / a1-policy-management / src / main / java / org / onap / ccsdk / oran / a1policymanagementservice / controllers / v2 / ServiceRegistrationInfo.java

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 68afc38..17277c9 100644 (file)
--- 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
@@ -23,30 +23,29 @@ package org.onap.ccsdk.oran.a1policymanagementservice.controllers.v2;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.google.gson.annotations.SerializedName;
 
-import io.swagger.annotations.ApiModel;
-import io.swagger.annotations.ApiModelProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
 
 import org.immutables.gson.Gson;
 
 @Gson.TypeAdapters
-@ApiModel(value = "service_registration_info_v2", description = "Information for one service")
+@Schema(name = "service_registration_info_v2", description = "Information for one service")
 public class ServiceRegistrationInfo {
 
-    @ApiModelProperty(value = "identity of the service", required = true, allowEmptyValue = false)
-    @SerializedName(value = "service_id")
+    @Schema(description = "identity of the service", required = true)
+    @SerializedName("service_id")
     @JsonProperty("service_id")
     public String serviceId = "";
 
-    @ApiModelProperty(value = "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;
 
-    @ApiModelProperty(value = "callback for notifying of RIC synchronization", required = false, allowEmptyValue = true)
+    @Schema(description = "callback for notifying of Near-RT RIC state changes", required = false)
     @SerializedName("callback_url")
     @JsonProperty("callback_url")
     public String callbackUrl = "";