#1287 Fixing some generation

nemerosa · Jun 5, 2024 · bff8928 · bff8928
1 parent da83ee3
commit bff8928
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 13 deletions.
diff --git a/...rosa/ontrack/extension/workflows/notifications/WorkflowNotificationChannelNodeExecutor.kt b/...rosa/ontrack/extension/workflows/notifications/WorkflowNotificationChannelNodeExecutor.kt
@@ -18,21 +18,25 @@ import net.nemerosa.ontrack.model.events.Event
 import org.springframework.stereotype.Component
 
 @Component
-@APIDescription("""
+@APIDescription(
+    """
     Wraps a notification in a workflow node.
     
     The output of this execution is exactly the output
     of the notification channel.
-""")
-@DocumentationExampleCode("""
-    executorId: notification
-    data:
-        channel: slack
-        channelConfig:
-            channel: "#my-channel"
-        template: |
-            Message template
-""")
+"""
+)
+@DocumentationExampleCode(
+    """
+        executorId: notification
+        data:
+            channel: slack
+            channelConfig:
+                channel: "#my-channel"
+            template: |
+                Message template
+    """
+)
 @Documentation(WorkflowNotificationChannelNodeData::class)
 class WorkflowNotificationChannelNodeExecutor(
     workflowsExtensionFeature: WorkflowsExtensionFeature,

diff --git a/ontrack-model/src/main/java/net/nemerosa/ontrack/model/docs/DocumentationUtils.kt b/ontrack-model/src/main/java/net/nemerosa/ontrack/model/docs/DocumentationUtils.kt
@@ -60,8 +60,9 @@ fun getFieldsForDocumentationClass(documentationClass: KClass<*>): List<FieldDoc
     return fields
 }
 
-fun getFieldsDocumentation(type: KClass<*>, section: String = ""): List<FieldDocumentation> {
+fun getFieldsDocumentation(type: KClass<*>, section: String = "", required: Boolean = true): List<FieldDocumentation> {
     val documentationAnnotation = type.findAnnotations<Documentation>().firstOrNull { it.section == section }
+    if (documentationAnnotation == null && !required) return emptyList()
     val documentationClass = documentationAnnotation?.value ?: type
     return getFieldsForDocumentationClass(documentationClass)
 }

diff --git a/ontrack-ui/src/test/java/net/nemerosa/ontrack/boot/docs/DocumentationGenerationIT.kt b/ontrack-ui/src/test/java/net/nemerosa/ontrack/boot/docs/DocumentationGenerationIT.kt
@@ -58,6 +58,12 @@ class DocumentationGenerationIT : AbstractDocumentationGenerationTestSupport() {
 
             val fileId = getWNXFileId(wnx)
 
+            val outputFieldsDocumentation = try {
+                getFieldsDocumentation(wnx::class, section = "output", required = false)
+            } catch (any: Exception) {
+                fail("Failed to get output fields documentation for ${wnx::class.simpleName}", any)
+            }
+
             directoryContext.writeFile(
                 fileId = fileId,
                 level = 4,
@@ -67,7 +73,7 @@ class DocumentationGenerationIT : AbstractDocumentationGenerationTestSupport() {
                 example = example,
                 links = wnx::class.findAnnotations(),
                 extendedConfig = { s ->
-                    val output = getFieldsDocumentation(wnx::class, section = "output")
+                    val output = outputFieldsDocumentation
                     if (output.isNotEmpty()) {
                         s.append("Output:\n\n")
                         directoryContext.writeFields(s, output)