feat(zeebe): add documentationRef

Related to bpmn-io/bpmn-js-properties-panel#614
camunda · Mar 21, 2022 · 8cff570 · 8cff570
1 parent bda0098
commit 8cff570
Show file tree

Hide file tree

Showing 4 changed files with 69 additions and 0 deletions.
diff --git a/packages/zeebe-element-templates-json-schema/resources/schema.json b/packages/zeebe-element-templates-json-schema/resources/schema.json
@@ -598,6 +598,14 @@
                   }
                 }
               }
+            },
+            "documentationRef": {
+              "$id": "#/documentaionRef",
+              "type": "string",
+              "pattern": "^(https|http)://.*",
+              "errorMessage": {
+                "pattern": "Malformed documentation URL, must match \"^(https|http)://.*\""
+              }
             }
           },
           "errorMessage": {

diff --git a/packages/zeebe-element-templates-json-schema/test/fixtures/documentation-ref.js b/packages/zeebe-element-templates-json-schema/test/fixtures/documentation-ref.js
@@ -0,0 +1,11 @@
+export const template = {
+  'name': 'Documentation Ref',
+  'id': 'com.camunda.example.DocumentationRef',
+  'appliesTo': [
+    'bpmn:Task'
+  ],
+  'properties': [],
+  'documentationRef': 'https://www.example.com/myTask'
+};
+
+export const errors = null;
diff --git a/packages/zeebe-element-templates-json-schema/test/fixtures/invalid-documentation-ref.js b/packages/zeebe-element-templates-json-schema/test/fixtures/invalid-documentation-ref.js
@@ -0,0 +1,44 @@
+export const template = {
+  'name': 'Documentation Ref',
+  'id': 'com.camunda.example.DocumentationRef',
+  'appliesTo': [
+    'bpmn:Task'
+  ],
+  'properties': [],
+  'documentationRef': 'foo'
+};
+
+export const errors = [
+  {
+    keyword: 'errorMessage',
+    dataPath: '/documentationRef',
+    schemaPath: '#/allOf/0/properties/documentationRef/errorMessage',
+    params: {
+      errors: [
+        {
+          keyword: 'pattern',
+          dataPath: '/documentationRef',
+          schemaPath: '#/allOf/0/properties/documentationRef/pattern',
+          params: { pattern: '^(https|http)://.*' },
+          message: 'should match pattern "^(https|http)://.*"',
+          emUsed: true
+        }
+      ]
+    },
+    message: 'Malformed documentation URL, must match "^(https|http)://.*"'
+  },
+  {
+    keyword: 'type',
+    dataPath: '',
+    schemaPath: '#/oneOf/1/type',
+    params: { type: 'array' },
+    message: 'should be array'
+  },
+  {
+    keyword: 'oneOf',
+    dataPath: '',
+    schemaPath: '#/oneOf',
+    params: { passingSchemas: null },
+    message: 'should match exactly one schema in oneOf'
+  }
+];
diff --git a/packages/zeebe-element-templates-json-schema/test/spec/validationSpec.js b/packages/zeebe-element-templates-json-schema/test/spec/validationSpec.js
@@ -146,6 +146,12 @@ describe('validation', function() {
     testTemplate('optional-invalid-not-empty');
 
 
+    testTemplate('documentation-ref');
+
+
+    testTemplate('invalid-documentation-ref');
+
+
     describe('property type - binding type', function() {
 
       testTemplate('invalid-property-type');