Merge pull request #129 from Systems-Modeling/feature/SYSMOAS_-8-2

SYSMOAS_-8: add description to all Record subtypes

Author: manasbajaj

app/org/omg/sysml/lifecycle/impl/CommitImpl.java

@@ -44,7 +44,6 @@ public class CommitImpl extends RecordImpl implements Commit {
     private Project owningProject;
     private Set<DataVersion> change;
     private ZonedDateTime created;
-    private String description;
     private Commit previousCommit;
 
     @Override
@@ -83,21 +82,6 @@ public void setCreated(ZonedDateTime created) {
         this.created = created;
     }
 
-    @JsonProperty(required = true)
-    @JsonGetter
-    @Lob
-    @org.hibernate.annotations.Type(type = "org.hibernate.type.TextType")
-    @javax.persistence.Column(name = "description", table = "Commit")
-    public String getDescription() {
-        return description;
-    }
-
-    @JsonProperty(required = true)
-    @JsonSetter
-    public void setDescription(String description) {
-        this.description = description;
-    }
-
     @ManyToOne(targetEntity = CommitImpl.class, fetch = FetchType.LAZY)
     @JsonSerialize(as = CommitImpl.class, using = RecordSerialization.RecordSerializer.class)
     public Commit getPreviousCommit() {

app/org/omg/sysml/record/Record.java

@@ -39,4 +39,9 @@ public interface Record {
     Set<String> getAlias();
 
     void setAlias(Set<String> alias);
+
+    @Nullable
+    String getDescription();
+
+    void setDescription(@Nullable String description);
 }

app/org/omg/sysml/record/impl/RecordImpl.java

@@ -23,6 +23,7 @@
 package org.omg.sysml.record.impl;
 
 import com.fasterxml.jackson.annotation.JsonGetter;
+import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonSetter;
 import org.omg.sysml.record.Record;
 
@@ -39,6 +40,7 @@ public abstract class RecordImpl implements Record {
     private UUID id;
     private String name;
     private Set<String> alias = new LinkedHashSet<>();
+    private String description;
 
     @Override
     @Id
@@ -90,4 +92,19 @@ public void setAlias(Set<String> alias) {
             this.alias.add(name);
         }
     }
+
+    @Override
+    @JsonGetter
+    @Lob
+    @org.hibernate.annotations.Type(type = "org.hibernate.type.TextType")
+    @Column(name = "description")
+    public @Nullable String getDescription() {
+        return description;
+    }
+
+    @Override
+    @JsonSetter
+    public void setDescription(@Nullable String description) {
+        this.description = description;
+    }
 }

conf/json/schema/api/schemas-sans-metamodel-requests.json

@@ -125,6 +125,16 @@
             }
           ]
         },
+        "description": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
         "head": {
           "oneOf": [
             {
@@ -154,6 +164,7 @@
         "alias",
         "created",
         "deleted",
+        "description",
         "head",
         "name",
         "owningProject",
@@ -176,6 +187,16 @@
             "type": "string"
           }
         },
+        "description": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
         "head": {
           "oneOf": [
             {
@@ -231,6 +252,16 @@
             }
           ]
         },
+        "description": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
         "name": {
           "type": "string"
         },
@@ -253,6 +284,7 @@
         "alias",
         "created",
         "deleted",
+        "description",
         "name",
         "owningProject",
         "referencedCommit",
@@ -275,6 +307,16 @@
             "type": "string"
           }
         },
+        "description": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
         "name": {
           "type": "string"
         },
@@ -422,6 +464,16 @@
             "type": "string"
           }
         },
+        "description": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
         "identity": {
           "$ref": "https://www.omg.org/spec/SystemsModelingAPI/20230201/DataIdentity"
         },
@@ -450,6 +502,7 @@
         "@id",
         "@type",
         "alias",
+        "description",
         "identity",
         "name",
         "payload"
@@ -471,6 +524,16 @@
             "type": "string"
           }
         },
+        "description": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
         "identity": {
           "$ref": "https://www.omg.org/spec/SystemsModelingAPI/20230201/DataIdentityRequest"
         },
@@ -555,6 +618,16 @@
             "type": "string"
           }
         },
+        "description": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
         "name": {
           "oneOf": [
             {
@@ -570,6 +643,7 @@
         "@id",
         "@type",
         "alias",
+        "description",
         "name"
       ],
       "additionalProperties": false
@@ -593,6 +667,16 @@
             "type": "string"
           }
         },
+        "description": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
         "name": {
           "oneOf": [
             {
@@ -869,6 +953,16 @@
             "type": "string"
           }
         },
+        "description": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
         "name": {
           "type": "string"
         },
@@ -897,6 +991,7 @@
         "@id",
         "@type",
         "alias",
+        "description",
         "name",
         "owningProject",
         "select",
@@ -919,6 +1014,16 @@
             "type": "string"
           }
         },
+        "description": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
         "name": {
           "type": "string"
         },