@camunda/element-templates-json-schema 0.19.0 → 0.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +2 -2
  2. package/resources/schema.json +44 -34
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@camunda/element-templates-json-schema",
3
- "version": "0.19.0",
3
+ "version": "0.20.0",
4
4
  "description": "JSON Schema for (Camunda) Element Templates",
5
5
  "files": [
6
6
  "resources"
@@ -25,5 +25,5 @@
25
25
  "camunda"
26
26
  ],
27
27
  "license": "MIT",
28
- "gitHead": "eacd0db659c67bf6f90440c6afdbfec767abadf7"
28
+ "gitHead": "092e8fa005c236f5fa02bb3e359a5132ea48b43e"
29
29
  }
package/resources/schema.json CHANGED
@@ -7,7 +7,7 @@
7
7
  "allOf": [
8
8
  {
9
9
  "type": "array",
10
- "description": "List of properties of the element template.",
10
+ "description": "List of the template's properties.",
11
11
  "allOf": [
12
12
  {
13
13
  "examples": [
@@ -56,19 +56,21 @@
56
56
  "type": {
57
57
  "$id": "#/condition/type",
58
58
  "const": "simple",
59
- "description": "The type of the condition.",
59
+ "description": "Defines the type of the condition (always \"simple\").",
60
60
  "default": "simple"
61
61
  },
62
62
  "property": {
63
63
  "$id": "#/condition/property",
64
64
  "type": "string",
65
- "description": "The id of the property to check."
65
+ "description": "Reference to the property used to evaluate the condition."
66
66
  }
67
67
  },
68
68
  "oneOf": [
69
69
  {
70
+ "description": "Checks if the referenced property's value is in the list of values defined in the condition.",
70
71
  "properties": {
71
72
  "equals": {
73
+ "description": "Checks if the referenced property's value is equal to the value defined in the condition.",
72
74
  "type": [
73
75
  "string",
74
76
  "number",
@@ -100,7 +102,7 @@
100
102
  "properties": {
101
103
  "isActive": {
102
104
  "type": "boolean",
103
- "description": "For `true`, activates the property when given property is active"
105
+ "description": "Checks if the referenced property is currently active and not hidden by other conditions."
104
106
  }
105
107
  },
106
108
  "required": [
@@ -148,11 +150,11 @@
148
150
  "properties": {
149
151
  "id": {
150
152
  "type": "string",
151
- "description": "Unique identifier of the property."
153
+ "description": "Unique identifier of the property. Can be used to, for example, reference the property for checks."
152
154
  },
153
155
  "condition": {
154
156
  "type": "object",
155
- "description": "Condition(s) to activate the binding.",
157
+ "description": "Object that defines when a property should be displayed in the properties panel and its value should be included in the XML.",
156
158
  "allOf": [
157
159
  {
158
160
  "examples": [
@@ -203,7 +205,8 @@
203
205
  "items": {
204
206
  "$ref": "#/definitions/properties/allOf/0/items/allOf/1/definitions/condition"
205
207
  },
206
- "minItems": 1
208
+ "minItems": 1,
209
+ "description": "List of conditions that must all be met for the property to be active."
207
210
  }
208
211
  },
209
212
  "required": [
@@ -266,7 +269,8 @@
266
269
  "then": {
267
270
  "properties": {
268
271
  "placeholder": {
269
- "type": "string"
272
+ "type": "string",
273
+ "description": "Placeholder text shown in the property input field when it is empty. Can be used to show example input."
270
274
  }
271
275
  }
272
276
  },
@@ -287,17 +291,17 @@
287
291
  "number",
288
292
  "boolean"
289
293
  ],
290
- "description": "The value of a control field."
294
+ "description": "Default value to be used if the user does not provide a value or if the type is Hidden."
291
295
  },
292
296
  "description": {
293
297
  "$id": "#/properties/property/description",
294
298
  "type": "string",
295
- "description": "The description of a control field."
299
+ "description": "Hint text shown below the property input field."
296
300
  },
297
301
  "label": {
298
302
  "$id": "#/properties/property/label",
299
303
  "type": "string",
300
- "description": "The label of a control field."
304
+ "description": "Label text shown above the property input field."
301
305
  },
302
306
  "type": {
303
307
  "$id": "#/properties/property/type",
@@ -307,12 +311,12 @@
307
311
  "editable": {
308
312
  "$id": "#/properties/property/editable",
309
313
  "type": "boolean",
310
- "description": "Indicates whether a control field is editable or not."
314
+ "description": "Defines whether users can edit the property in the properties panel. By default, all non-hidden properties are editable."
311
315
  },
312
316
  "choices": {
313
317
  "$id": "#/properties/property/choices",
314
318
  "type": "array",
315
- "description": "The choices for dropdown fields.",
319
+ "description": "List of choices for a dropdown field.",
316
320
  "default": [],
317
321
  "items": {
318
322
  "$id": "#/properties/property/choices/item",
@@ -322,12 +326,12 @@
322
326
  "name": {
323
327
  "$id": "#/properties/property/choices/item/name",
324
328
  "type": "string",
325
- "description": "The name of a choice."
329
+ "description": "Display name for a choice in a dropdown field. Shown to the user."
326
330
  },
327
331
  "value": {
328
332
  "$id": "#/properties/property/choices/item/value",
329
333
  "type": "string",
330
- "description": "The value of a choice."
334
+ "description": "Value for a choice in a dropdown field. Stored in the XML."
331
335
  },
332
336
  "condition": {
333
337
  "$ref": "#/definitions/properties/allOf/0/items/allOf/1/properties/condition"
@@ -342,7 +346,7 @@
342
346
  "constraints": {
343
347
  "$id": "#/properties/property/constraints",
344
348
  "type": "object",
345
- "description": "The validation constraints of a control field.",
349
+ "description": "Object that contains rules to validate user input to the template.",
346
350
  "allOf": [
347
351
  {
348
352
  "examples": [
@@ -370,7 +374,7 @@
370
374
  },
371
375
  "pattern": {
372
376
  "$id": "#/properties/property/constraints/pattern",
373
- "description": "A regular expression pattern for a constraint.",
377
+ "description": "String or object that defines a regular expression that the user's input must match.",
374
378
  "oneOf": [
375
379
  {
376
380
  "type": "object",
@@ -379,12 +383,12 @@
379
383
  "value": {
380
384
  "$id": "#/properties/property/constraints/pattern/value",
381
385
  "type": "string",
382
- "description": "The regular expression of a pattern."
386
+ "description": "The value of the regular expression."
383
387
  },
384
388
  "message": {
385
389
  "$id": "#/properties/property/constraints/pattern/message",
386
390
  "type": "string",
387
- "description": "The validation message of a pattern."
391
+ "description": "Custom error message to show when the user's input does not match the regular expression."
388
392
  }
389
393
  }
390
394
  },
@@ -398,7 +402,7 @@
398
402
  "group": {
399
403
  "$id": "#/properties/property/group",
400
404
  "type": "string",
401
- "description": "The custom group of a control field."
405
+ "description": "Group in the properties panel that the property belongs to."
402
406
  }
403
407
  }
404
408
  }
@@ -596,7 +600,7 @@
596
600
  "binding": {
597
601
  "$id": "#/properties/property/binding",
598
602
  "type": "object",
599
- "description": "Specifying how the property is mapped to BPMN or Camunda extension elements and attributes.",
603
+ "description": "Object that defines how the property is mapped to BPMN or Camunda extensions. Required.",
600
604
  "required": [
601
605
  "type"
602
606
  ],
@@ -910,25 +914,30 @@
910
914
  "properties"
911
915
  ],
912
916
  "properties": {
917
+ "$schema": {
918
+ "$id": "#/$schema",
919
+ "type": "string",
920
+ "description": "Reference to the Element Template JSON schema this document follows."
921
+ },
913
922
  "name": {
914
923
  "$id": "#/name",
915
924
  "type": "string",
916
- "description": "The name of the element template."
925
+ "description": "Template name. Shown during template selection and editing of a templated element. Required."
917
926
  },
918
927
  "id": {
919
928
  "$id": "#/id",
920
929
  "type": "string",
921
- "description": "The identifier of the element template."
930
+ "description": "Template identifier. Required."
922
931
  },
923
932
  "description": {
924
933
  "$id": "#/description",
925
934
  "type": "string",
926
- "description": "The description of the element template."
935
+ "description": "Template description. Shown during template selection and editing of a templated element."
927
936
  },
928
937
  "version": {
929
938
  "$id": "#/version",
930
939
  "type": "integer",
931
- "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."
940
+ "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."
932
941
  },
933
942
  "isDefault": {
934
943
  "$id": "#/isDefault",
@@ -941,7 +950,7 @@
941
950
  "boolean",
942
951
  "object"
943
952
  ],
944
- "description": "Indicates whether the element template is deprecated.",
953
+ "description": "Marks the template as deprecated. Value can be either a boolean or an object with a message and a link to migration documentation.",
945
954
  "properties": {
946
955
  "message": {
947
956
  "$id": "#/deprecated/message",
@@ -952,14 +961,14 @@
952
961
  "$id": "#/deprecated/documentationRef",
953
962
  "type": "string",
954
963
  "pattern": "^(https|http)://.*",
955
- "description": "Optional link to migration documentation."
964
+ "description": "URL pointing to template documentation. Must be a valid http(s) URL."
956
965
  }
957
966
  }
958
967
  },
959
968
  "appliesTo": {
960
969
  "$id": "#/appliesTo",
961
970
  "type": "array",
962
- "description": "List of BPMN types the template can be applied to.",
971
+ "description": "List of BPMN types the template can be applied to. Required.",
963
972
  "default": [],
964
973
  "items": {
965
974
  "$id": "#/appliesTo/items",
@@ -982,7 +991,7 @@
982
991
  "elementType": {
983
992
  "$id": "#/elementType",
984
993
  "type": "object",
985
- "description": "The BPMN type the element will be transformed into.",
994
+ "description": "Object that sets the type of the element. Some properties require a specific value for elementType.",
986
995
  "default": {},
987
996
  "required": [
988
997
  "value"
@@ -992,6 +1001,7 @@
992
1001
  "$id": "#/elementType/value",
993
1002
  "type": "string",
994
1003
  "pattern": "^[\\w\\d]+:[\\w\\d]+$",
1004
+ "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.",
995
1005
  "allOf": [
996
1006
  {
997
1007
  "examples": [
@@ -1018,18 +1028,18 @@
1018
1028
  "items": {
1019
1029
  "type": "string"
1020
1030
  },
1021
- "description": "List of keywords to describe the element template.",
1031
+ "description": "List of keywords to help users find the template. Used in search and filtering, but not displayed in the UI.",
1022
1032
  "default": []
1023
1033
  },
1024
1034
  "entriesVisible": {
1025
1035
  "$id": "#/entriesVisible",
1026
1036
  "type": "boolean",
1027
- "description": "Select whether non-template entries are visible in the properties panel."
1037
+ "description": "Defines whether all property input fields are shown, even those normally hidden by the template."
1028
1038
  },
1029
1039
  "groups": {
1030
1040
  "$id": "#/groups",
1031
1041
  "type": "array",
1032
- "description": "Custom fields can be ordered together via groups.",
1042
+ "description": "List of custom groups to organize related fields in the properties panel.",
1033
1043
  "allOf": [
1034
1044
  {
1035
1045
  "examples": [
@@ -1054,12 +1064,12 @@
1054
1064
  "id": {
1055
1065
  "$id": "#/groups/group/id",
1056
1066
  "type": "string",
1057
- "description": "The id of the custom group"
1067
+ "description": "Uniquely identifies a group object. Required if using groups."
1058
1068
  },
1059
1069
  "label": {
1060
1070
  "$id": "#/groups/group/label",
1061
1071
  "type": "string",
1062
- "description": "The label of the custom group"
1072
+ "description": "The label of the group, shown as a section header in the properties panel. Required if using groups."
1063
1073
  }
1064
1074
  }
1065
1075
  }