Merge pull request #173 from tsurdilo/annotations40x

[4.0.x] Adding support for annotations prop

Author: tsurdilo

api/src/main/java/io/serverlessworkflow/api/serializers/WorkflowSerializer.java

@@ -63,6 +63,10 @@ public void serialize(Workflow workflow, JsonGenerator gen, SerializerProvider p
       gen.writeStringField("version", workflow.getVersion());
     }
 
+    if (workflow.getAnnotations() != null && !workflow.getAnnotations().isEmpty()) {
+      gen.writeObjectField("annotations", workflow.getAnnotations());
+    }
+
     if (workflow.getDataInputSchema() != null) {
       if (workflow.getDataInputSchema().getSchema() != null
           && workflow.getDataInputSchema().getSchema().length() > 0

api/src/main/resources/schema/workflow.json

@@ -27,6 +27,14 @@
       "type": "string",
       "description": "Workflow version"
     },
+    "annotations": {
+      "type": "array",
+      "description": "List of helpful terms describing the workflows intended purpose, subject areas, or other important qualities",
+      "minItems": 1,
+      "items": {
+        "type": "string"
+      }
+    },
     "dataInputSchema": {
       "$ref": "datainputschema/datainputschema.json",
       "description": "Workflow data input schema"

api/src/test/java/io/serverlessworkflow/api/test/MarkupToWorkflowTest.java

@@ -838,4 +838,18 @@ public void testFunctionInvoke(String workflowLocation) {
     assertNotNull(action3.getEventRef().getInvoke());
     assertEquals(EventRef.Invoke.ASYNC, action3.getEventRef().getInvoke());
   }
+
+  @ParameterizedTest
+  @ValueSource(strings = {"/features/annotations.json", "/features/annotations.yml"})
+  public void testAnnotations(String workflowLocation) {
+    Workflow workflow = Workflow.fromSource(WorkflowTestUtils.readWorkflowFile(workflowLocation));
+
+    assertNotNull(workflow);
+    assertNotNull(workflow.getId());
+    assertNotNull(workflow.getName());
+
+    assertNotNull(workflow.getAnnotations());
+    List<String> annotations = workflow.getAnnotations();
+    assertEquals(4, annotations.size());
+  }
 }

api/src/test/resources/features/annotations.json

@@ -0,0 +1,6 @@
+{
+  "id" : "test-workflow",
+  "name" : "test-workflow-name",
+  "version" : "1.0",
+  "annotations": ["a", "b", "c", "d"]
+}

api/src/test/resources/features/annotations.yml

@@ -0,0 +1,8 @@
+id: test-workflow
+name: test-workflow-name
+version: '1.0'
+annotations:
+  - a
+  - b
+  - c
+  - d