Add ApiModelProperty annotation to authorative models

Add @ApiModelProperty to authorative models for the fields
that have different serialized names from their property names.

Issue-ID: POLICY-1515
Change-Id: Id6509afe5cc741a6253fc0d1f98ae6b22d31f0d9
Signed-off-by: Chenfei Gao <cgao@research.att.com>

diff --git a/models-tosca/pom.xml b/models-tosca/pom.xml
index c8fa252..5b857c1 100644 (file)
--- a/models-tosca/pom.xml
+++ b/models-tosca/pom.xml
@@ -68,6 +68,11 @@
             <artifactId>mariadb-java-client</artifactId>
             <scope>test</scope>
         </dependency>
+        
+        <dependency>
+            <groupId>io.swagger</groupId>
+            <artifactId>swagger-jersey2-jaxrs</artifactId>
+        </dependency>
 
     </dependencies>
 </project>

diff --git a/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaConstraint.java b/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaConstraint.java
index 4623b20..582b73c 100644 (file)
--- a/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaConstraint.java
+++ b/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaConstraint.java
@@ -24,6 +24,7 @@
 package org.onap.policy.models.tosca.authorative.concepts;
 
 import com.google.gson.annotations.SerializedName;
+import io.swagger.annotations.ApiModelProperty;
 import java.util.List;
 import lombok.Data;
 
@@ -35,20 +36,25 @@ import lombok.Data;
 @Data
 public class ToscaConstraint {
 
+    @ApiModelProperty(name = "valid_values")
     @SerializedName("valid_values")
     private List<String> validValues;
 
     private String equal;
 
+    @ApiModelProperty(name = "greater_than")
     @SerializedName("greater_than")
     private String greaterThan;
 
+    @ApiModelProperty(name = "greater_or_equal")
     @SerializedName("greater_or_equal")
     private String greaterOrEqual;
 
+    @ApiModelProperty(name = "less_than")
     @SerializedName("less_than")
     private String lessThan;
 
+    @ApiModelProperty(name = "less_or_equal")
     @SerializedName("less_or_equal")
     private String lessOrEqual;
 

diff --git a/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaEntity.java b/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaEntity.java
index a61f2a7..9d327a2 100644 (file)
--- a/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaEntity.java
+++ b/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaEntity.java
@@ -23,15 +23,13 @@
 package org.onap.policy.models.tosca.authorative.concepts;
 
 import com.google.gson.annotations.SerializedName;
-
+import io.swagger.annotations.ApiModelProperty;
 import java.util.LinkedHashMap;
 import java.util.Map;
 import java.util.Map.Entry;
-
 import lombok.Data;
 import lombok.NoArgsConstructor;
 import lombok.NonNull;
-
 import org.onap.policy.models.base.PfNameVersion;
 
 /**
@@ -46,6 +44,7 @@ public class ToscaEntity implements PfNameVersion {
 
     private String version;
 
+    @ApiModelProperty(name = "derived_from")
     @SerializedName("derived_from")
     private String derivedFrom;
 

diff --git a/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaPolicy.java b/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaPolicy.java
index 38c6859..6463abc 100644 (file)
--- a/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaPolicy.java
+++ b/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaPolicy.java
@@ -26,7 +26,6 @@ package org.onap.policy.models.tosca.authorative.concepts;
 import java.util.LinkedHashMap;
 import java.util.Map;
 import java.util.Map.Entry;
-
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.NoArgsConstructor;

diff --git a/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaProperty.java b/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaProperty.java
index 84f798b..00005f2 100644 (file)
--- a/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaProperty.java
+++ b/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaProperty.java
@@ -24,6 +24,7 @@
 package org.onap.policy.models.tosca.authorative.concepts;
 
 import com.google.gson.annotations.SerializedName;
+import io.swagger.annotations.ApiModelProperty;
 import java.util.List;
 import lombok.Data;
 
@@ -46,6 +47,7 @@ public class ToscaProperty {
 
     private String description;
 
+    @ApiModelProperty(name = "default")
     @SerializedName("default")
     private String defaultValue;
 
@@ -55,6 +57,7 @@ public class ToscaProperty {
 
     private List<ToscaConstraint> constraints;
 
+    @ApiModelProperty(name = "entry_schema")
     @SerializedName("entry_schema")
     private ToscaEntrySchema entrySchema;
 }

diff --git a/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaServiceTemplate.java b/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaServiceTemplate.java
index a9a1783..0b19708 100644 (file)
--- a/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaServiceTemplate.java
+++ b/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaServiceTemplate.java
@@ -24,6 +24,7 @@
 package org.onap.policy.models.tosca.authorative.concepts;
 
 import com.google.gson.annotations.SerializedName;
+import io.swagger.annotations.ApiModelProperty;
 import java.util.List;
 import java.util.Map;
 import lombok.Data;
@@ -38,15 +39,19 @@ import lombok.EqualsAndHashCode;
 @EqualsAndHashCode(callSuper = true)
 public class ToscaServiceTemplate extends ToscaEntity {
 
+    @ApiModelProperty(name = "tosca_definitions_version")
     @SerializedName("tosca_definitions_version")
     private String toscaDefinitionsVersion;
 
+    @ApiModelProperty(name = "topology_template")
     @SerializedName("topology_template")
     private ToscaTopologyTemplate toscaTopologyTemplate;
 
+    @ApiModelProperty(name = "policy_types")
     @SerializedName("policy_types")
     private List<Map<String, ToscaPolicyType>> policyTypes;
 
+    @ApiModelProperty(name = "data_types")
     @SerializedName("data_types")
     private List<Map<String, ToscaDataType>> dataTypes;
 }
\ No newline at end of file

diff --git a/models-tosca/src/main/java/org/onap/policy/models/tosca/legacy/concepts/LegacyGuardPolicyInput.java b/models-tosca/src/main/java/org/onap/policy/models/tosca/legacy/concepts/LegacyGuardPolicyInput.java
index 18853c1..819fcba 100644 (file)
--- a/models-tosca/src/main/java/org/onap/policy/models/tosca/legacy/concepts/LegacyGuardPolicyInput.java
+++ b/models-tosca/src/main/java/org/onap/policy/models/tosca/legacy/concepts/LegacyGuardPolicyInput.java
@@ -22,7 +22,7 @@
 package org.onap.policy.models.tosca.legacy.concepts;
 
 import com.google.gson.annotations.SerializedName;
-
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -33,9 +33,11 @@ import lombok.Data;
 @Data
 public class LegacyGuardPolicyInput {
 
+    @ApiModelProperty(name = "policy-id")
     @SerializedName("policy-id")
     private String policyId;
 
+    @ApiModelProperty(name = "policy-version")
     @SerializedName("policy-version")
     private String policyVersion;
 

diff --git a/models-tosca/src/main/java/org/onap/policy/models/tosca/legacy/concepts/LegacyOperationalPolicy.java b/models-tosca/src/main/java/org/onap/policy/models/tosca/legacy/concepts/LegacyOperationalPolicy.java
index 1db4d6e..70453da 100644 (file)
--- a/models-tosca/src/main/java/org/onap/policy/models/tosca/legacy/concepts/LegacyOperationalPolicy.java
+++ b/models-tosca/src/main/java/org/onap/policy/models/tosca/legacy/concepts/LegacyOperationalPolicy.java
@@ -22,7 +22,7 @@
 package org.onap.policy.models.tosca.legacy.concepts;
 
 import com.google.gson.annotations.SerializedName;
-
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -33,9 +33,11 @@ import lombok.Data;
 @Data
 public class LegacyOperationalPolicy {
 
+    @ApiModelProperty(name = "policy-id")
     @SerializedName("policy-id")
     private String policyId;
 
+    @ApiModelProperty(name = "policy-version")
     @SerializedName("policy-version")
     private String policyVersion;