Renamed Decision.Link.type to Decision.Link.description.

Author: simonbrowndotje

build.gradle

@@ -14,7 +14,7 @@ subprojects { proj ->
 
     description = 'Structurizr'
     group = 'com.structurizr'
-    version = '1.12.0'
+    version = '1.12.1'
 
     repositories {
         mavenCentral()

docs/changelog.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.12.1 (2nd March 2022)
+
+- Renamed `Decision.Link.type` to `Decision.Link.description`. 
+
 ## 1.12.0 (1st March 2022)
 
 - Breaking API changes to how documentation and decisions are managed.

docs/getting-started.md

@@ -12,7 +12,7 @@ The Structurizr for Java binaries are hosted on [Maven Central](https://repo1.ma
 
 Name                                     | Description
 ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------
-com.structurizr:structurizr-client:1.12.0 | The Structurizr API client library.
+com.structurizr:structurizr-client:1.12.1 | The Structurizr API client library.
 
 ## 2. Create a Java program
 

structurizr-core/src/com/structurizr/documentation/Decision.java

@@ -128,18 +128,19 @@ public int hashCode() {
      */
     public static final class Link {
 
-        private String type;
         private String id;
+        private String description = "";
 
         Link() {
         }
 
-        Link(String id, String type) {
+        Link(String id, String description) {
             if (StringUtils.isNullOrEmpty(id)) {
-                throw new IllegalArgumentException("Link ID must be specfied");
+                throw new IllegalArgumentException("Link ID must be specified");
             }
-            this.id = id;
-            this.type = type;
+
+            setId(id);
+            setDescription(description);
         }
 
         public String getId() {
@@ -150,12 +151,21 @@ void setId(String id) {
             this.id = id;
         }
 
-        public String getType() {
-            return type;
+        /**
+         * Gets the description of this link.
+         *
+         * @return      a String description
+         */
+        public String getDescription() {
+            return description;
         }
 
-        void setType(String type) {
-            this.type = type;
+        void setDescription(String description) {
+            if (!StringUtils.isNullOrEmpty(description)) {
+                this.description = description;
+            } else {
+                this.description = "";
+            }
         }
 
         @Override
@@ -165,13 +175,13 @@ public boolean equals(Object o) {
 
             Link link = (Link) o;
 
-            if (!type.equals(link.type)) return false;
+            if (!description.equals(link.description)) return false;
             return id.equals(link.id);
         }
 
         @Override
         public int hashCode() {
-            int result = type.hashCode();
+            int result = description.hashCode();
             result = 31 * result + id.hashCode();
             return result;
         }