Adds better backwards compatibility for removal of documentation sect…

…ions.
structurizr · Mar 11, 2023 · 864f5de · 864f5de
1 parent fe12158
commit 864f5de
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 1 deletion.
diff --git a/build.gradle b/build.gradle
@@ -8,7 +8,7 @@ subprojects { proj ->
 
     description = 'Structurizr'
     group = 'com.structurizr'
-    version = '1.22.2'
+    version = '1.22.3'
 
     repositories {
         mavenCentral()

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.22.3 (11th March 2023)
+
+- Adds better backwards compatibility for removal of documentation sections.
+
 ## 1.22.2 (10th March 2023)
 
 - Updates Jackson library dependency.

diff --git a/structurizr-client/test/integration/com/structurizr/api/BackwardsCompatibilityTests.java b/structurizr-client/test/integration/com/structurizr/api/BackwardsCompatibilityTests.java
@@ -1,10 +1,16 @@
 package com.structurizr.api;
 
+import com.structurizr.Workspace;
+import com.structurizr.documentation.Format;
+import com.structurizr.documentation.Section;
+import com.structurizr.model.Location;
 import com.structurizr.util.WorkspaceUtils;
 import org.junit.jupiter.api.Test;
 
 import java.io.File;
 
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
 class BackwardsCompatibilityTests {
 
     private static final File PATH_TO_WORKSPACE_FILES = new File("test/integration/backwardsCompatibility");
@@ -16,4 +22,12 @@ void test() throws Exception {
         }
     }
 
+    @Test
+    void documentation() throws Exception {
+        Workspace workspace = new Workspace("Name", "Description");
+        workspace.getDocumentation().addSection(new Section(Format.Markdown, "## Heading 1"));
+
+        assertEquals("{\"id\":0,\"name\":\"Name\",\"description\":\"Description\",\"configuration\":{},\"model\":{},\"documentation\":{\"sections\":[{\"content\":\"## Heading 1\",\"format\":\"Markdown\",\"order\":1,\"title\":\"\"}]},\"views\":{\"configuration\":{\"branding\":{},\"styles\":{},\"terminology\":{}}}}", WorkspaceUtils.toJson(workspace, false));
+    }
+
 }
diff --git a/structurizr-core/src/com/structurizr/documentation/Section.java b/structurizr-core/src/com/structurizr/documentation/Section.java
@@ -1,5 +1,8 @@
 package com.structurizr.documentation;
 
+import com.fasterxml.jackson.annotation.JsonGetter;
+import com.fasterxml.jackson.annotation.JsonInclude;
+
 /**
  * A documentation section.
  */
@@ -16,6 +19,15 @@ public Section(Format format, String content) {
         setContent(content);
     }
 
+    /**
+     * This method is retained for backwards compatibility.
+     */
+    @JsonGetter
+    @JsonInclude(JsonInclude.Include.ALWAYS)
+    public String getTitle() {
+        return "";
+    }
+
     /**
      * Gets the filename of this section.
      *