fix : Error where markdown format is broken

wwan13 · Sep 16, 2024 · b735505 · b735505
1 parent b14b699
commit b735505
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 9 deletions.
diff --git a/api/src/main/kotlin/io/wwan13/api/document/ApiDocumentContext.kt b/api/src/main/kotlin/io/wwan13/api/document/ApiDocumentContext.kt
@@ -17,9 +17,10 @@ import org.springframework.restdocs.request.PathParametersSnippet
 import org.springframework.restdocs.request.RequestDocumentation
 import org.springframework.restdocs.request.RequestParametersSnippet
 import org.springframework.restdocs.snippet.Snippet
+import kotlin.String as String1
 
 data class ApiDocumentContext(
-    val identifier: String,
+    val identifier: String1,
     val summary: DocumentSummary,
     val guide: DocumentGuide,
     val enums: List<DocumentEnum>,
@@ -47,13 +48,17 @@ data class ApiDocumentContext(
             return snippets.toTypedArray()
         }
 
-    val description: String
-        get() = MarkdownConverter.join(
-            summary.description,
-            MarkdownConverter.convertGuide(guide),
-            MarkdownConverter.convertEnums(enums),
-            MarkdownConverter.convertErrors(errors),
-        )
+    val description: String1
+        get() {
+            val elements = mutableListOf<String1>()
+
+            if (summary.hasDescription()) elements.add(summary.description)
+            if (guide.hasValue()) elements.add(MarkdownConverter.convertGuide(guide))
+            if (enums.isNotEmpty()) elements.add(MarkdownConverter.convertEnums(enums))
+            if (errors.isNotEmpty()) elements.add(MarkdownConverter.convertErrors(errors))
+
+            return MarkdownConverter.join(elements)
+        }
 
     private val allResponseFields: List<DocumentField>
         get() {

diff --git a/api/src/main/kotlin/io/wwan13/api/document/util/MarkdownConverter.kt b/api/src/main/kotlin/io/wwan13/api/document/util/MarkdownConverter.kt
@@ -8,6 +8,7 @@ object MarkdownConverter {
 
     fun convertGuide(guide: DocumentGuide): String {
         return """
+            |
             |### Api Guide
             |
             |${guide.value.joinToString("\n") { "- $it" }}
@@ -26,6 +27,7 @@ object MarkdownConverter {
         }
 
         return """
+            |
             |### Enum Values
             |
             |<details>
@@ -40,6 +42,7 @@ object MarkdownConverter {
 
     fun convertErrors(errors: List<DocumentError>): String {
         return """
+            |
             |### Error Codes
             |
             |<details>
@@ -54,7 +57,7 @@ object MarkdownConverter {
         """.trimMargin()
     }
 
-    fun join(vararg values: String): String {
+    fun join(values: List<String>): String {
         return values.joinToString("<br/>")
     }
 }