feat(element-templates): support metadata with keywords

Related to #3089
camunda · Oct 8, 2024 · 1c6a1ac · 1c6a1ac
1 parent 97c0e45
commit 1c6a1ac
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 0 deletions.
diff --git a/...late-generator/core/src/main/java/io/camunda/connector/generator/dsl/ElementTemplate.java b/...late-generator/core/src/main/java/io/camunda/connector/generator/dsl/ElementTemplate.java
@@ -31,6 +31,7 @@
   "name",
   "id",
   "description",
+  "metadata",
   "documentationRef",
   "version",
   "category",
@@ -46,6 +47,7 @@ public record ElementTemplate(
     int version,
     String documentationRef,
     String description,
+    Metadata metadata,
     Set<String> appliesTo,
     ElementTypeWrapper elementType,
     List<PropertyGroup> groups,
@@ -117,6 +119,14 @@ public String schema() {
     return SCHEMA_URL;
   }
 
+  public static class Metadata {
+    List<String> keywords;
+
+    public Metadata(List<String> keywords) {
+      this.keywords = keywords;
+    }
+  }
+
   @JsonInclude(Include.NON_NULL)
   public record ElementTypeWrapper(
       String value, String eventDefinition, @JsonIgnore BpmnType originalType) {

diff --git a/...nerator/core/src/main/java/io/camunda/connector/generator/dsl/ElementTemplateBuilder.java b/...nerator/core/src/main/java/io/camunda/connector/generator/dsl/ElementTemplateBuilder.java
@@ -17,6 +17,7 @@
 package io.camunda.connector.generator.dsl;
 
 import io.camunda.connector.generator.dsl.ElementTemplate.ElementTypeWrapper;
+import io.camunda.connector.generator.dsl.ElementTemplate.Metadata;
 import io.camunda.connector.generator.dsl.Property.FeelMode;
 import io.camunda.connector.generator.dsl.PropertyBinding.ZeebeProperty;
 import io.camunda.connector.generator.dsl.PropertyBinding.ZeebeTaskDefinition;
@@ -47,6 +48,7 @@ private ElementTemplateBuilder(Mode mode) {
   protected ElementTemplateIcon icon;
   protected String documentationRef;
   protected String description;
+  protected Metadata metadata;
   protected Set<String> appliesTo;
   protected BpmnType elementType;
   protected final List<PropertyGroup> groups = new ArrayList<>();
@@ -149,6 +151,11 @@ public ElementTemplateBuilder description(String description) {
     return this;
   }
 
+  public ElementTemplateBuilder metadata(Metadata metadata) {
+    this.metadata = metadata;
+    return this;
+  }
+
   public ElementTemplateBuilder appliesTo(Set<BpmnType> appliesTo) {
     this.appliesTo = appliesTo.stream().map(BpmnType::getName).collect(Collectors.toSet());
     return this;

diff --git a/...re/src/test/java/io/camunda/connector/generator/dsl/ElementTemplateSerializationTest.java b/...re/src/test/java/io/camunda/connector/generator/dsl/ElementTemplateSerializationTest.java
@@ -18,6 +18,7 @@
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import io.camunda.connector.generator.dsl.DropdownProperty.DropdownChoice;
+import io.camunda.connector.generator.dsl.ElementTemplate.Metadata;
 import io.camunda.connector.generator.dsl.Property.FeelMode;
 import io.camunda.connector.generator.dsl.PropertyBinding.ZeebeInput;
 import io.camunda.connector.generator.dsl.PropertyBinding.ZeebeTaskHeader;
@@ -48,6 +49,7 @@ void serializationTest() throws Exception {
             .documentationRef(
                 "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/available-connectors-overview/")
             .description("Describe this connector")
+            .metadata(new Metadata(List.of("foo", "bar")))
             .propertyGroups(
                 PropertyGroup.builder()
                     .id("authentication")