@camunda/element-templates-json-schema-shared 0.12.1 → 0.13.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@camunda/element-templates-json-schema-shared",
-  "version": "0.12.1",
+  "version": "0.13.0",
   "description": "Shared schema definitions used within element-templates-json-schema",
   "files": [
     "src"
@@ -16,5 +16,5 @@
     "camunda"
   ],
   "license": "MIT",
-  "gitHead": "f5d5f22a7f4bf98714cdce1a99ac5d782310b99a"
+  "gitHead": "092e8fa005c236f5fa02bb3e359a5132ea48b43e"
 }

package/src/defs/base-properties.json

@@ -1,6 +1,6 @@
 {
   "type": "array",
-  "description": "List of properties of the element template.",
+  "description": "List of the template's properties.",
   "allOf": [
     { "$ref": "examples.json#/properties" }
   ],
@@ -80,7 +80,8 @@
         "then": {
           "properties": {
             "placeholder": {
-              "type": "string"
+              "type": "string",
+              "description": "Placeholder text shown in the property input field when it is empty. Can be used to show example input."
             }
           }
         },
@@ -101,17 +102,17 @@
           "number",
           "boolean"
         ],
-        "description": "The value of a control field."
+        "description": "Default value to be used if the user does not provide a value or if the type is Hidden."
       },
       "description": {
         "$id": "#/properties/property/description",
         "type": "string",
-        "description": "The description of a control field."
+        "description": "Hint text shown below the property input field."
       },
       "label": {
         "$id": "#/properties/property/label",
         "type": "string",
-        "description": "The label of a control field."
+        "description": "Label text shown above the property input field."
       },
       "type": {
         "$id": "#/properties/property/type",
@@ -121,12 +122,12 @@
       "editable": {
         "$id": "#/properties/property/editable",
         "type": "boolean",
-        "description": "Indicates whether a control field is editable or not."
+        "description": "Defines whether users can edit the property in the properties panel. By default, all non-hidden properties are editable."
       },
       "choices": {
         "$id": "#/properties/property/choices",
         "type": "array",
-        "description": "The choices for dropdown fields.",
+        "description": "List of choices for a dropdown field.",
         "default": [],
         "items": {
           "$id": "#/properties/property/choices/item",
@@ -136,12 +137,12 @@
             "name": {
               "$id": "#/properties/property/choices/item/name",
               "type": "string",
-              "description": "The name of a choice."
+              "description": "Display name for a choice in a dropdown field. Shown to the user."
             },
             "value": {
               "$id": "#/properties/property/choices/item/value",
               "type": "string",
-              "description": "The value of a choice."
+              "description": "Value for a choice in a dropdown field. Stored in the XML."
             },
             "condition": {
               "$ref": "condition.json#/properties/condition"
@@ -156,7 +157,7 @@
       "constraints": {
         "$id": "#/properties/property/constraints",
         "type": "object",
-        "description": "The validation constraints of a control field.",
+        "description": "Object that contains rules to validate user input to the template.",
         "allOf": [
           { "$ref": "examples.json#/constraints" }
         ],
@@ -178,7 +179,7 @@
           },
           "pattern": {
             "$id": "#/properties/property/constraints/pattern",
-            "description": "A regular expression pattern for a constraint.",
+            "description": "String or object that defines a regular expression that the user's input must match.",
             "oneOf": [
               {
                 "type": "object",
@@ -187,12 +188,12 @@
                   "value": {
                     "$id": "#/properties/property/constraints/pattern/value",
                     "type": "string",
-                    "description": "The regular expression of a pattern."
+                    "description": "The value of the regular expression."
                   },
                   "message": {
                     "$id": "#/properties/property/constraints/pattern/message",
                     "type": "string",
-                    "description": "The validation message of a pattern."
+                    "description": "Custom error message to show when the user's input does not match the regular expression."
                   }
                 }
               },
@@ -206,7 +207,7 @@
       "group": {
         "$id": "#/properties/property/group",
         "type": "string",
-        "description": "The custom group of a control field."
+        "description": "Group in the properties panel that the property belongs to."
       }
     }
   }

package/src/defs/base.json

@@ -6,25 +6,30 @@
     "properties"
   ],
   "properties": {
+    "$schema": {
+      "$id": "#/$schema",
+      "type": "string",
+      "description": "Reference to the Element Template JSON schema this document follows."
+    },
     "name": {
       "$id": "#/name",
       "type": "string",
-      "description": "The name of the element template."
+      "description": "Template name. Shown during template selection and editing of a templated element. Required."
     },
     "id": {
       "$id": "#/id",
       "type": "string",
-      "description": "The identifier of the element template."
+      "description": "Template identifier. Required."
     },
     "description": {
       "$id": "#/description",
       "type": "string",
-      "description": "The description of the element template."
+      "description": "Template description. Shown during template selection and editing of a templated element."
     },
     "version": {
       "$id": "#/version",
       "type": "integer",
-      "description": "Optional version of the template. If you add a version to a template it will be considered unique based on its ID and version. Two templates can have the same ID if their version is different."
+      "description": "Optional version of the template. If you add a version to a template, it will be considered unique based on its ID and version. Two templates can have the same ID if their versions are different."
     },
     "isDefault": {
       "$id": "#/isDefault",
@@ -34,7 +39,7 @@
     "deprecated": {
       "$id": "#/deprecated",
       "type": ["boolean", "object"],
-      "description": "Indicates whether the element template is deprecated.",
+      "description": "Marks the template as deprecated. Value can be either a boolean or an object with a message and a link to migration documentation.",
       "properties": {
         "message": {
           "$id": "#/deprecated/message",
@@ -45,14 +50,14 @@
           "$id": "#/deprecated/documentationRef",
           "type": "string",
           "pattern": "^(https|http)://.*",
-          "description": "Optional link to migration documentation."
+          "description": "URL pointing to template documentation. Must be a valid http(s) URL."
         }
       }
     },
     "appliesTo": {
       "$id": "#/appliesTo",
       "type": "array",
-      "description": "List of BPMN types the template can be applied to.",
+      "description": "List of BPMN types the template can be applied to. Required.",
       "default": [],
       "items": {
         "$id": "#/appliesTo/items",
@@ -68,7 +73,7 @@
     "elementType": {
       "$id": "#/elementType",
       "type": "object",
-      "description": "The BPMN type the element will be transformed into.",
+      "description": "Object that sets the type of the element. Some properties require a specific value for elementType.",
       "default": {},
       "required": [
         "value"
@@ -78,6 +83,7 @@
           "$id": "#/elementType/value",
           "type": "string",
           "pattern": "^[\\w\\d]+:[\\w\\d]+$",
+          "description": "Specifies the target BPMN element type. The element is replaced with the specified type when a user applies the template. Required if using elementType.",
           "allOf": [
             {
               "$ref": "examples.json#/elementType"
@@ -96,13 +102,13 @@
       "$id": "#/keywords",
       "type": "array",
       "items": { "type": "string" },
-      "description": "List of keywords to describe the element template.",
+      "description": "List of keywords to help users find the template. Used in search and filtering, but not displayed in the UI.",
       "default": []
     },
     "entriesVisible": {
       "$id": "#/entriesVisible",
       "type": "boolean",
-      "description": "Select whether non-template entries are visible in the properties panel."
+      "description": "Defines whether all property input fields are shown, even those normally hidden by the template."
     },
     "groups": {
       "$ref": "groups.json"

package/src/defs/condition.json

@@ -9,19 +9,21 @@
         "type": {
           "$id": "#/condition/type",
           "const": "simple",
-          "description": "The type of the condition.",
+          "description": "Defines the type of the condition (always \"simple\").",
           "default": "simple"
         },
         "property": {
           "$id": "#/condition/property",
           "type": "string",
-          "description": "The id of the property to check."
+          "description": "Reference to the property used to evaluate the condition."
         }
       },
       "oneOf": [
         {
+          "description": "Checks if the referenced property's value is in the list of values defined in the condition.",
           "properties": {
             "equals": {
+              "description": "Checks if the referenced property's value is equal to the value defined in the condition.",
               "type": [
                 "string",
                 "number",
@@ -53,7 +55,7 @@
           "properties": {
             "isActive": {
               "type": "boolean",
-              "description": "For `true`, activates the property when given property is active"
+              "description": "Checks if the referenced property is currently active and not hidden by other conditions."
             }
           },
           "required": [
@@ -99,11 +101,11 @@
   "properties": {
     "id": {
       "type": "string",
-      "description": "Unique identifier of the property."
+      "description": "Unique identifier of the property. Can be used to, for example, reference the property for checks."
     },
     "condition": {
       "type": "object",
-      "description": "Condition(s) to activate the binding.",
+      "description": "Object that defines when a property should be displayed in the properties panel and its value should be included in the XML.",
       "allOf": [
         {
           "$ref": "examples.json#/condition"
@@ -121,7 +123,8 @@
               "items": {
                 "$ref": "#/definitions/condition"
               },
-              "minItems": 1
+              "minItems": 1,
+              "description": "List of conditions that must all be met for the property to be active."
             }
           },
           "required": [

package/src/defs/groups.json

@@ -1,7 +1,7 @@
 {
   "$id": "#/groups",
   "type": "array",
-  "description": "Custom fields can be ordered together via groups.",
+  "description": "List of custom groups to organize related fields in the properties panel.",
   "allOf": [
     {
       "$ref": "examples.json#/groups"
@@ -19,12 +19,12 @@
       "id": {
         "$id": "#/groups/group/id",
         "type": "string",
-        "description": "The id of the custom group"
+        "description": "Uniquely identifies a group object. Required if using groups."
       },
       "label": {
         "$id": "#/groups/group/label",
         "type": "string",
-        "description": "The label of the custom group"
+        "description": "The label of the group, shown as a section header in the properties panel. Required if using groups."
       }
     }
   }