@forge/manifest 3.1.0-next.0 → 3.1.0-next.4

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.
@@ -3526,11 +3526,6 @@
3526
3526
  "maxLength": 23,
3527
3527
  "pattern": "^[a-zA-Z0-9_\\-]+$"
3528
3528
  },
3529
- "resourceUploadId": {
3530
- "type": "string",
3531
- "minLength": 1,
3532
- "maxLength": 255
3533
- },
3534
3529
  "key": {
3535
3530
  "$ref": "#/definitions/ModuleKeySchema"
3536
3531
  }
@@ -3618,11 +3613,6 @@
3618
3613
  "maxLength": 23,
3619
3614
  "pattern": "^[a-zA-Z0-9_\\-]+$"
3620
3615
  },
3621
- "resourceUploadId": {
3622
- "type": "string",
3623
- "minLength": 1,
3624
- "maxLength": 255
3625
- },
3626
3616
  "key": {
3627
3617
  "$ref": "#/definitions/ModuleKeySchema"
3628
3618
  }
@@ -3704,11 +3694,6 @@
3704
3694
  "maxLength": 23,
3705
3695
  "pattern": "^[a-zA-Z0-9_\\-]+$"
3706
3696
  },
3707
- "resourceUploadId": {
3708
- "type": "string",
3709
- "minLength": 1,
3710
- "maxLength": 255
3711
- },
3712
3697
  "key": {
3713
3698
  "$ref": "#/definitions/ModuleKeySchema"
3714
3699
  }
@@ -3882,10 +3867,10 @@
3882
3867
  "type": "object",
3883
3868
  "anyOf": [
3884
3869
  {
3885
- "$ref": "#/definitions/compositeCondition"
3870
+ "$ref": "#/definitions/singleCondition"
3886
3871
  },
3887
3872
  {
3888
- "$ref": "#/definitions/singleCondition"
3873
+ "$ref": "#/definitions/compositeCondition"
3889
3874
  }
3890
3875
  ]
3891
3876
  },
@@ -3937,10 +3922,10 @@
3937
3922
  "type": "object",
3938
3923
  "anyOf": [
3939
3924
  {
3940
- "$ref": "#/definitions/singleCondition"
3925
+ "$ref": "#/definitions/compositeCondition"
3941
3926
  },
3942
3927
  {
3943
- "$ref": "#/definitions/compositeCondition"
3928
+ "$ref": "#/definitions/singleCondition"
3944
3929
  }
3945
3930
  ]
3946
3931
  },
@@ -4353,33 +4338,6 @@
4353
4338
  "items": {
4354
4339
  "type": "object",
4355
4340
  "anyOf": [
4356
- {
4357
- "properties": {
4358
- "condition": {
4359
- "maxLength": 100,
4360
- "type": "string",
4361
- "fieldDescription": "\n\nA string indicating the name of the condition\n\n"
4362
- },
4363
- "invert": {
4364
- "type": "boolean",
4365
- "fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
4366
- "defaultValue": "false"
4367
- },
4368
- "params": {
4369
- "additionalProperties": true,
4370
- "type": "object",
4371
- "fieldTitle": "Object",
4372
- "fieldDescription": "\n\nThis object represents a map of key/value pairs, where each property name and value corresponds to the parameter name and value respectively.\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"params\": {\n \"someOtherProperty\": \"someValue\",\n \"myCustomProperty\": \"myValue\"\n }\n }\n\n\n"
4373
- }
4374
- },
4375
- "required": [
4376
- "condition"
4377
- ],
4378
- "shortClassName": "singleConditionBean",
4379
- "type": "object",
4380
- "title": "Single Condition",
4381
- "description": "\n\nSingle Conditions are either provided by the host application. See the complete documentation of\n [Conditions](../../conditions/) for more information.\n\n To invert a condition, add the attribute ``invert=\"true\"`` to the condition element.\n This is useful where you want to show the section if a certain condition is not satisfied.\n\n <h3>Example</h3>\n\n\n\n\n\n {\n \"condition\": \"user_is_logged_in\",\n \"invert\": false\n }\n\n\n"
4382
- },
4383
4341
  {
4384
4342
  "properties": {
4385
4343
  "conditions": {
@@ -4412,6 +4370,33 @@
4412
4370
  "type": "object",
4413
4371
  "title": "Composite Condition",
4414
4372
  "description": "\n\nComposite Conditions are composed of a collection of [Single Condition](../single-condition/) / Composite Conditions\n and a type attribute.\n\n <h3>Example</h3>\n\n\n\n\n\n {\n \"conditions\": [\n {\n \"or\": [\n {\n \"condition\": \"can_attach_file_to_issue\",\n \"invert\": false\n },\n {\n \"condition\": \"is_issue_assigned_to_current_user\",\n \"invert\": false\n }\n ]\n },\n {\n \"condition\": \"user_is_logged_in\",\n \"invert\": false\n }\n ]\n }\n\n\n"
4373
+ },
4374
+ {
4375
+ "properties": {
4376
+ "condition": {
4377
+ "maxLength": 100,
4378
+ "type": "string",
4379
+ "fieldDescription": "\n\nA string indicating the name of the condition\n\n"
4380
+ },
4381
+ "invert": {
4382
+ "type": "boolean",
4383
+ "fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
4384
+ "defaultValue": "false"
4385
+ },
4386
+ "params": {
4387
+ "additionalProperties": true,
4388
+ "type": "object",
4389
+ "fieldTitle": "Object",
4390
+ "fieldDescription": "\n\nThis object represents a map of key/value pairs, where each property name and value corresponds to the parameter name and value respectively.\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"params\": {\n \"someOtherProperty\": \"someValue\",\n \"myCustomProperty\": \"myValue\"\n }\n }\n\n\n"
4391
+ }
4392
+ },
4393
+ "required": [
4394
+ "condition"
4395
+ ],
4396
+ "shortClassName": "singleConditionBean",
4397
+ "type": "object",
4398
+ "title": "Single Condition",
4399
+ "description": "\n\nSingle Conditions are either provided by the host application. See the complete documentation of\n [Conditions](../../conditions/) for more information.\n\n To invert a condition, add the attribute ``invert=\"true\"`` to the condition element.\n This is useful where you want to show the section if a certain condition is not satisfied.\n\n <h3>Example</h3>\n\n\n\n\n\n {\n \"condition\": \"user_is_logged_in\",\n \"invert\": false\n }\n\n\n"
4415
4400
  }
4416
4401
  ]
4417
4402
  },
@@ -6262,10 +6247,10 @@
6262
6247
  "type": "object",
6263
6248
  "anyOf": [
6264
6249
  {
6265
- "$ref": "#/definitions/singleCondition"
6250
+ "$ref": "#/definitions/compositeCondition"
6266
6251
  },
6267
6252
  {
6268
- "$ref": "#/definitions/compositeCondition"
6253
+ "$ref": "#/definitions/singleCondition"
6269
6254
  }
6270
6255
  ]
6271
6256
  },
@@ -6326,10 +6311,10 @@
6326
6311
  "type": "object",
6327
6312
  "anyOf": [
6328
6313
  {
6329
- "$ref": "#/definitions/singleCondition"
6314
+ "$ref": "#/definitions/compositeCondition"
6330
6315
  },
6331
6316
  {
6332
- "$ref": "#/definitions/compositeCondition"
6317
+ "$ref": "#/definitions/singleCondition"
6333
6318
  }
6334
6319
  ]
6335
6320
  },
@@ -6442,10 +6427,10 @@
6442
6427
  "type": "object",
6443
6428
  "anyOf": [
6444
6429
  {
6445
- "$ref": "#/definitions/singleCondition"
6430
+ "$ref": "#/definitions/compositeCondition"
6446
6431
  },
6447
6432
  {
6448
- "$ref": "#/definitions/compositeCondition"
6433
+ "$ref": "#/definitions/singleCondition"
6449
6434
  }
6450
6435
  ]
6451
6436
  },
@@ -6678,6 +6663,33 @@
6678
6663
  "items": {
6679
6664
  "type": "object",
6680
6665
  "anyOf": [
6666
+ {
6667
+ "properties": {
6668
+ "condition": {
6669
+ "maxLength": 100,
6670
+ "type": "string",
6671
+ "fieldDescription": "\n\nA string indicating the name of the condition\n\n"
6672
+ },
6673
+ "invert": {
6674
+ "type": "boolean",
6675
+ "fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
6676
+ "defaultValue": "false"
6677
+ },
6678
+ "params": {
6679
+ "additionalProperties": true,
6680
+ "type": "object",
6681
+ "fieldTitle": "Object",
6682
+ "fieldDescription": "\n\nThis object represents a map of key/value pairs, where each property name and value corresponds to the parameter name and value respectively.\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"params\": {\n \"someOtherProperty\": \"someValue\",\n \"myCustomProperty\": \"myValue\"\n }\n }\n\n\n"
6683
+ }
6684
+ },
6685
+ "required": [
6686
+ "condition"
6687
+ ],
6688
+ "shortClassName": "singleConditionBean",
6689
+ "type": "object",
6690
+ "title": "Single Condition",
6691
+ "description": "\n\nSingle Conditions are either provided by the host application. See the complete documentation of\n [Conditions](../../conditions/) for more information.\n\n To invert a condition, add the attribute ``invert=\"true\"`` to the condition element.\n This is useful where you want to show the section if a certain condition is not satisfied.\n\n <h3>Example</h3>\n\n\n\n\n\n {\n \"condition\": \"user_is_logged_in\",\n \"invert\": false\n }\n\n\n"
6692
+ },
6681
6693
  {
6682
6694
  "properties": {
6683
6695
  "conditions": {
@@ -6685,10 +6697,10 @@
6685
6697
  "type": "object",
6686
6698
  "anyOf": [
6687
6699
  {
6688
- "$ref": "#/definitions/singleCondition"
6700
+ "$ref": "#"
6689
6701
  },
6690
6702
  {
6691
- "$ref": "#"
6703
+ "$ref": "#/definitions/singleCondition"
6692
6704
  }
6693
6705
  ]
6694
6706
  },
@@ -6710,33 +6722,6 @@
6710
6722
  "type": "object",
6711
6723
  "title": "Composite Condition",
6712
6724
  "description": "\n\nComposite Conditions are composed of a collection of [Single Condition](../single-condition/) / Composite Conditions\n and a type attribute.\n\n <h3>Example</h3>\n\n\n\n\n\n {\n \"conditions\": [\n {\n \"or\": [\n {\n \"condition\": \"can_attach_file_to_issue\",\n \"invert\": false\n },\n {\n \"condition\": \"is_issue_assigned_to_current_user\",\n \"invert\": false\n }\n ]\n },\n {\n \"condition\": \"user_is_logged_in\",\n \"invert\": false\n }\n ]\n }\n\n\n"
6713
- },
6714
- {
6715
- "properties": {
6716
- "condition": {
6717
- "maxLength": 100,
6718
- "type": "string",
6719
- "fieldDescription": "\n\nA string indicating the name of the condition\n\n"
6720
- },
6721
- "invert": {
6722
- "type": "boolean",
6723
- "fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
6724
- "defaultValue": "false"
6725
- },
6726
- "params": {
6727
- "additionalProperties": true,
6728
- "type": "object",
6729
- "fieldTitle": "Object",
6730
- "fieldDescription": "\n\nThis object represents a map of key/value pairs, where each property name and value corresponds to the parameter name and value respectively.\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"params\": {\n \"someOtherProperty\": \"someValue\",\n \"myCustomProperty\": \"myValue\"\n }\n }\n\n\n"
6731
- }
6732
- },
6733
- "required": [
6734
- "condition"
6735
- ],
6736
- "shortClassName": "singleConditionBean",
6737
- "type": "object",
6738
- "title": "Single Condition",
6739
- "description": "\n\nSingle Conditions are either provided by the host application. See the complete documentation of\n [Conditions](../../conditions/) for more information.\n\n To invert a condition, add the attribute ``invert=\"true\"`` to the condition element.\n This is useful where you want to show the section if a certain condition is not satisfied.\n\n <h3>Example</h3>\n\n\n\n\n\n {\n \"condition\": \"user_is_logged_in\",\n \"invert\": false\n }\n\n\n"
6740
6725
  }
6741
6726
  ]
6742
6727
  },
@@ -6941,33 +6926,6 @@
6941
6926
  "items": {
6942
6927
  "type": "object",
6943
6928
  "anyOf": [
6944
- {
6945
- "properties": {
6946
- "condition": {
6947
- "maxLength": 100,
6948
- "type": "string",
6949
- "fieldDescription": "\n\nA string indicating the name of the condition\n\n"
6950
- },
6951
- "invert": {
6952
- "type": "boolean",
6953
- "fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
6954
- "defaultValue": "false"
6955
- },
6956
- "params": {
6957
- "additionalProperties": true,
6958
- "type": "object",
6959
- "fieldTitle": "Object",
6960
- "fieldDescription": "\n\nThis object represents a map of key/value pairs, where each property name and value corresponds to the parameter name and value respectively.\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"params\": {\n \"someOtherProperty\": \"someValue\",\n \"myCustomProperty\": \"myValue\"\n }\n }\n\n\n"
6961
- }
6962
- },
6963
- "required": [
6964
- "condition"
6965
- ],
6966
- "shortClassName": "singleConditionBean",
6967
- "type": "object",
6968
- "title": "Single Condition",
6969
- "description": "\n\nSingle Conditions are either provided by the host application. See the complete documentation of\n [Conditions](../../conditions/) for more information.\n\n To invert a condition, add the attribute ``invert=\"true\"`` to the condition element.\n This is useful where you want to show the section if a certain condition is not satisfied.\n\n <h3>Example</h3>\n\n\n\n\n\n {\n \"condition\": \"user_is_logged_in\",\n \"invert\": false\n }\n\n\n"
6970
- },
6971
6929
  {
6972
6930
  "properties": {
6973
6931
  "conditions": {
@@ -6975,10 +6933,10 @@
6975
6933
  "type": "object",
6976
6934
  "anyOf": [
6977
6935
  {
6978
- "$ref": "#/definitions/singleCondition"
6936
+ "$ref": "#"
6979
6937
  },
6980
6938
  {
6981
- "$ref": "#"
6939
+ "$ref": "#/definitions/singleCondition"
6982
6940
  }
6983
6941
  ]
6984
6942
  },
@@ -7000,6 +6958,33 @@
7000
6958
  "type": "object",
7001
6959
  "title": "Composite Condition",
7002
6960
  "description": "\n\nComposite Conditions are composed of a collection of [Single Condition](../single-condition/) / Composite Conditions\n and a type attribute.\n\n <h3>Example</h3>\n\n\n\n\n\n {\n \"conditions\": [\n {\n \"or\": [\n {\n \"condition\": \"can_attach_file_to_issue\",\n \"invert\": false\n },\n {\n \"condition\": \"is_issue_assigned_to_current_user\",\n \"invert\": false\n }\n ]\n },\n {\n \"condition\": \"user_is_logged_in\",\n \"invert\": false\n }\n ]\n }\n\n\n"
6961
+ },
6962
+ {
6963
+ "properties": {
6964
+ "condition": {
6965
+ "maxLength": 100,
6966
+ "type": "string",
6967
+ "fieldDescription": "\n\nA string indicating the name of the condition\n\n"
6968
+ },
6969
+ "invert": {
6970
+ "type": "boolean",
6971
+ "fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
6972
+ "defaultValue": "false"
6973
+ },
6974
+ "params": {
6975
+ "additionalProperties": true,
6976
+ "type": "object",
6977
+ "fieldTitle": "Object",
6978
+ "fieldDescription": "\n\nThis object represents a map of key/value pairs, where each property name and value corresponds to the parameter name and value respectively.\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"params\": {\n \"someOtherProperty\": \"someValue\",\n \"myCustomProperty\": \"myValue\"\n }\n }\n\n\n"
6979
+ }
6980
+ },
6981
+ "required": [
6982
+ "condition"
6983
+ ],
6984
+ "shortClassName": "singleConditionBean",
6985
+ "type": "object",
6986
+ "title": "Single Condition",
6987
+ "description": "\n\nSingle Conditions are either provided by the host application. See the complete documentation of\n [Conditions](../../conditions/) for more information.\n\n To invert a condition, add the attribute ``invert=\"true\"`` to the condition element.\n This is useful where you want to show the section if a certain condition is not satisfied.\n\n <h3>Example</h3>\n\n\n\n\n\n {\n \"condition\": \"user_is_logged_in\",\n \"invert\": false\n }\n\n\n"
7003
6988
  }
7004
6989
  ]
7005
6990
  },
@@ -7310,22 +7295,17 @@
7310
7295
  "controls": {
7311
7296
  "items": {
7312
7297
  "properties": {
7313
- "macroParameterValue": {
7314
- "maxLength": 10000,
7315
- "type": "string",
7316
- "fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n"
7317
- },
7318
7298
  "label": {
7319
7299
  "$ref": "#/definitions/i18nProperty",
7320
7300
  "fieldDescription": "\n\nText which will appear inside the button\n\n"
7321
7301
  },
7322
7302
  "type": {
7323
7303
  "enum": [
7324
- "togglebutton",
7325
- "TOGGLEBUTTON"
7304
+ "button",
7305
+ "BUTTON"
7326
7306
  ],
7327
7307
  "type": "string",
7328
- "fieldDescription": "\n\nThe type field must be set to 'togglebutton'\n\n"
7308
+ "fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
7329
7309
  },
7330
7310
  "key": {
7331
7311
  "pattern": "^[a-zA-Z0-9-]+$",
@@ -7335,61 +7315,58 @@
7335
7315
  }
7336
7316
  },
7337
7317
  "required": [
7338
- "macroParameterValue",
7339
7318
  "label",
7340
7319
  "type",
7341
7320
  "key"
7342
7321
  ],
7343
7322
  "additionalProperties": true,
7344
- "shortClassName": "macroToggleButtonControlBean",
7323
+ "shortClassName": "buttonControlBean",
7345
7324
  "type": "object",
7346
- "title": "ToggleButtonControl",
7347
- "description": "\n\nDefines a toggle button which appears inside a ToggleGroup\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"type\": \"togglebutton\",\n \"macroParameterValue\": \"macroParameterValue 0\",\n \"label\": {\n \"value\": \"My Custom Control 0\"\n },\n \"key\": \"my-custom-toggle-button-0\"\n }\n\n\n"
7325
+ "title": "ButtonControl",
7326
+ "description": "\n\nDefines a button which may appear in control extension points such as the property panel\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"type\": \"button\",\n \"label\": {\n \"value\": \"My Custom Control 0\"\n },\n \"key\": \"my-custom-control-0\"\n }\n\n\n"
7348
7327
  },
7349
7328
  "type": "array",
7350
- "fieldDescription": "\n\nToggle buttons which will appear in the toggle group\n\n"
7351
- },
7352
- "macroParameter": {
7353
- "pattern": "[-_a-z0-9\\.]+",
7354
- "maxLength": 100,
7355
- "type": "string",
7356
- "fieldDescription": "\n\nThe macro parameter identifier used to store the toggle state.\n It must only contain lowercase alphanumeric characters, dashes, underscores, dots and must not contain any spaces.\n\n"
7329
+ "fieldDescription": "\n\nControls which will appear in the control group\n\n"
7357
7330
  },
7358
7331
  "type": {
7359
7332
  "enum": [
7360
- "togglegroup",
7361
- "TOGGLEGROUP"
7333
+ "group",
7334
+ "GROUP"
7362
7335
  ],
7363
7336
  "type": "string",
7364
- "fieldDescription": "\n\nThe type field must be set to 'togglegroup'\n\n"
7337
+ "fieldDescription": "\n\nThe type field must be set to 'group'\n\n"
7365
7338
  }
7366
7339
  },
7367
7340
  "required": [
7368
7341
  "controls",
7369
- "macroParameter",
7370
7342
  "type"
7371
7343
  ],
7372
- "shortClassName": "macroToggleGroupBean",
7344
+ "shortClassName": "controlGroupBean",
7373
7345
  "type": "object",
7374
- "title": "ToggleGroup",
7375
- "description": "\n\nDefines a ToggleGroup which may appear in control extension points such as the property panel\n\n <p><b>Example</b></p>\n\n\n\n\n\n [\n {\n \"type\": \"togglegroup\",\n \"macroParameter\": \"toggleGroupMacroParameter\",\n \"controls\": [\n {\n \"type\": \"togglebutton\",\n \"macroParameterValue\": \"macroParameterValue 0\",\n \"label\": {\n \"value\": \"My Custom Control 0\"\n },\n \"key\": \"my-custom-toggle-button-0\"\n },\n {\n \"type\": \"togglebutton\",\n \"macroParameterValue\": \"macroParameterValue 1\",\n \"label\": {\n \"value\": \"My Custom Control 1\"\n },\n \"key\": \"my-custom-toggle-button-1\"\n }\n ]\n }\n ]\n\n\n"
7346
+ "title": "ControlGroup",
7347
+ "description": "\n\nDefines a ControlGroup which may appear in control extension points such as the property panel\n\n <p><b>Example</b></p>\n\n\n\n\n\n [\n {\n \"type\": \"group\",\n \"controls\": [\n {\n \"type\": \"button\",\n \"label\": {\n \"value\": \"My Custom Control 0\"\n },\n \"key\": \"my-custom-control-0\"\n },\n {\n \"type\": \"button\",\n \"label\": {\n \"value\": \"My Custom Control 1\"\n },\n \"key\": \"my-custom-control-1\"\n }\n ]\n }\n ]\n\n\n"
7376
7348
  },
7377
7349
  {
7378
7350
  "properties": {
7379
7351
  "controls": {
7380
7352
  "items": {
7381
7353
  "properties": {
7354
+ "macroParameterValue": {
7355
+ "maxLength": 10000,
7356
+ "type": "string",
7357
+ "fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n"
7358
+ },
7382
7359
  "label": {
7383
7360
  "$ref": "#/definitions/i18nProperty",
7384
7361
  "fieldDescription": "\n\nText which will appear inside the button\n\n"
7385
7362
  },
7386
7363
  "type": {
7387
7364
  "enum": [
7388
- "button",
7389
- "BUTTON"
7365
+ "togglebutton",
7366
+ "TOGGLEBUTTON"
7390
7367
  ],
7391
7368
  "type": "string",
7392
- "fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
7369
+ "fieldDescription": "\n\nThe type field must be set to 'togglebutton'\n\n"
7393
7370
  },
7394
7371
  "key": {
7395
7372
  "pattern": "^[a-zA-Z0-9-]+$",
@@ -7399,36 +7376,44 @@
7399
7376
  }
7400
7377
  },
7401
7378
  "required": [
7379
+ "macroParameterValue",
7402
7380
  "label",
7403
7381
  "type",
7404
7382
  "key"
7405
7383
  ],
7406
7384
  "additionalProperties": true,
7407
- "shortClassName": "buttonControlBean",
7385
+ "shortClassName": "macroToggleButtonControlBean",
7408
7386
  "type": "object",
7409
- "title": "ButtonControl",
7410
- "description": "\n\nDefines a button which may appear in control extension points such as the property panel\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"type\": \"button\",\n \"label\": {\n \"value\": \"My Custom Control 0\"\n },\n \"key\": \"my-custom-control-0\"\n }\n\n\n"
7387
+ "title": "ToggleButtonControl",
7388
+ "description": "\n\nDefines a toggle button which appears inside a ToggleGroup\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"type\": \"togglebutton\",\n \"macroParameterValue\": \"macroParameterValue 0\",\n \"label\": {\n \"value\": \"My Custom Control 0\"\n },\n \"key\": \"my-custom-toggle-button-0\"\n }\n\n\n"
7411
7389
  },
7412
7390
  "type": "array",
7413
- "fieldDescription": "\n\nControls which will appear in the control group\n\n"
7391
+ "fieldDescription": "\n\nToggle buttons which will appear in the toggle group\n\n"
7392
+ },
7393
+ "macroParameter": {
7394
+ "pattern": "[-_a-z0-9\\.]+",
7395
+ "maxLength": 100,
7396
+ "type": "string",
7397
+ "fieldDescription": "\n\nThe macro parameter identifier used to store the toggle state.\n It must only contain lowercase alphanumeric characters, dashes, underscores, dots and must not contain any spaces.\n\n"
7414
7398
  },
7415
7399
  "type": {
7416
7400
  "enum": [
7417
- "group",
7418
- "GROUP"
7401
+ "togglegroup",
7402
+ "TOGGLEGROUP"
7419
7403
  ],
7420
7404
  "type": "string",
7421
- "fieldDescription": "\n\nThe type field must be set to 'group'\n\n"
7405
+ "fieldDescription": "\n\nThe type field must be set to 'togglegroup'\n\n"
7422
7406
  }
7423
7407
  },
7424
7408
  "required": [
7425
7409
  "controls",
7410
+ "macroParameter",
7426
7411
  "type"
7427
7412
  ],
7428
- "shortClassName": "controlGroupBean",
7413
+ "shortClassName": "macroToggleGroupBean",
7429
7414
  "type": "object",
7430
- "title": "ControlGroup",
7431
- "description": "\n\nDefines a ControlGroup which may appear in control extension points such as the property panel\n\n <p><b>Example</b></p>\n\n\n\n\n\n [\n {\n \"type\": \"group\",\n \"controls\": [\n {\n \"type\": \"button\",\n \"label\": {\n \"value\": \"My Custom Control 0\"\n },\n \"key\": \"my-custom-control-0\"\n },\n {\n \"type\": \"button\",\n \"label\": {\n \"value\": \"My Custom Control 1\"\n },\n \"key\": \"my-custom-control-1\"\n }\n ]\n }\n ]\n\n\n"
7415
+ "title": "ToggleGroup",
7416
+ "description": "\n\nDefines a ToggleGroup which may appear in control extension points such as the property panel\n\n <p><b>Example</b></p>\n\n\n\n\n\n [\n {\n \"type\": \"togglegroup\",\n \"macroParameter\": \"toggleGroupMacroParameter\",\n \"controls\": [\n {\n \"type\": \"togglebutton\",\n \"macroParameterValue\": \"macroParameterValue 0\",\n \"label\": {\n \"value\": \"My Custom Control 0\"\n },\n \"key\": \"my-custom-toggle-button-0\"\n },\n {\n \"type\": \"togglebutton\",\n \"macroParameterValue\": \"macroParameterValue 1\",\n \"label\": {\n \"value\": \"My Custom Control 1\"\n },\n \"key\": \"my-custom-toggle-button-1\"\n }\n ]\n }\n ]\n\n\n"
7432
7417
  },
7433
7418
  {
7434
7419
  "properties": {
@@ -7757,104 +7742,67 @@
7757
7742
  "anyOf": [
7758
7743
  {
7759
7744
  "properties": {
7760
- "controls": {
7761
- "items": {
7762
- "properties": {
7763
- "macroParameterValue": {
7764
- "maxLength": 10000,
7765
- "type": "string",
7766
- "fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n"
7767
- },
7768
- "label": {
7769
- "$ref": "#/definitions/i18nProperty",
7770
- "fieldDescription": "\n\nText which will appear inside the button\n\n"
7771
- },
7772
- "type": {
7773
- "enum": [
7774
- "togglebutton",
7775
- "TOGGLEBUTTON"
7776
- ],
7777
- "type": "string",
7778
- "fieldDescription": "\n\nThe type field must be set to 'togglebutton'\n\n"
7779
- },
7780
- "key": {
7781
- "pattern": "^[a-zA-Z0-9-]+$",
7782
- "maxLength": 100,
7783
- "type": "string",
7784
- "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
7785
- }
7786
- },
7787
- "required": [
7788
- "macroParameterValue",
7789
- "label",
7790
- "type",
7791
- "key"
7792
- ],
7793
- "additionalProperties": true,
7794
- "shortClassName": "macroToggleButtonControlBean",
7795
- "type": "object",
7796
- "title": "ToggleButtonControl",
7797
- "description": "\n\nDefines a toggle button which appears inside a ToggleGroup\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"type\": \"togglebutton\",\n \"macroParameterValue\": \"macroParameterValue 0\",\n \"label\": {\n \"value\": \"My Custom Control 0\"\n },\n \"key\": \"my-custom-toggle-button-0\"\n }\n\n\n"
7798
- },
7799
- "type": "array",
7800
- "fieldDescription": "\n\nToggle buttons which will appear in the toggle group\n\n"
7801
- },
7802
7745
  "macroParameter": {
7803
- "pattern": "[-_a-z0-9\\.]+",
7804
7746
  "maxLength": 100,
7805
7747
  "type": "string",
7806
- "fieldDescription": "\n\nThe macro parameter identifier used to store the toggle state.\n It must only contain lowercase alphanumeric characters, dashes, underscores, dots and must not contain any spaces.\n\n"
7748
+ "fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
7807
7749
  },
7808
7750
  "type": {
7809
7751
  "enum": [
7810
- "togglegroup",
7811
- "TOGGLEGROUP"
7752
+ "text",
7753
+ "TEXT"
7812
7754
  ],
7813
7755
  "type": "string",
7814
- "fieldDescription": "\n\nThe type field must be set to 'togglegroup'\n\n"
7756
+ "fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
7757
+ },
7758
+ "key": {
7759
+ "pattern": "^[a-zA-Z0-9-]+$",
7760
+ "maxLength": 100,
7761
+ "type": "string",
7762
+ "fieldDescription": "\n\nA key to identify this module.\n\n This key must be unique relative to the add on, with the exception of Confluence macros: Their keys need to be\n globally unique.\n\n Keys must only contain alphanumeric characters and dashes.\n\n The key is used to generate the url to your add-on's module. The url is generated as a combination of your add-on\n key and module key. For example, an add-on which looks like:\n\n {\n \"key\": \"my-addon\",\n \"modules\": {\n \"configurePage\": {\n \"key\": \"configure-me\",\n }\n }\n }\n\n Will have a configuration page module with a URL of `/plugins/servlet/ac/my-addon/configure-me`.\n\n"
7815
7763
  }
7816
7764
  },
7817
7765
  "required": [
7818
- "controls",
7819
7766
  "macroParameter",
7820
- "type"
7767
+ "type",
7768
+ "key"
7821
7769
  ],
7822
- "shortClassName": "macroToggleGroupBean",
7770
+ "shortClassName": "textControlBean",
7823
7771
  "type": "object",
7824
- "title": "ToggleGroup",
7825
- "description": "\n\nDefines a ToggleGroup which may appear in control extension points such as the property panel\n\n <p><b>Example</b></p>\n\n\n\n\n\n [\n {\n \"type\": \"togglegroup\",\n \"macroParameter\": \"toggleGroupMacroParameter\",\n \"controls\": [\n {\n \"type\": \"togglebutton\",\n \"macroParameterValue\": \"macroParameterValue 0\",\n \"label\": {\n \"value\": \"My Custom Control 0\"\n },\n \"key\": \"my-custom-toggle-button-0\"\n },\n {\n \"type\": \"togglebutton\",\n \"macroParameterValue\": \"macroParameterValue 1\",\n \"label\": {\n \"value\": \"My Custom Control 1\"\n },\n \"key\": \"my-custom-toggle-button-1\"\n }\n ]\n }\n ]\n\n\n"
7772
+ "title": "TextControl",
7773
+ "description": "\n\nDefines a text field which may appear in control extension points such as the property panel\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"type\": \"button\",\n \"label\": {\n \"value\": \"My Custom Control 0\"\n },\n \"key\": \"my-custom-control-0\"\n }\n\n\n"
7826
7774
  },
7827
7775
  {
7828
7776
  "properties": {
7829
- "macroParameter": {
7830
- "maxLength": 100,
7831
- "type": "string",
7832
- "fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
7777
+ "label": {
7778
+ "$ref": "#/definitions/i18nProperty",
7779
+ "fieldDescription": "\n\nText which will appear inside the button\n\n"
7833
7780
  },
7834
7781
  "type": {
7835
7782
  "enum": [
7836
- "text",
7837
- "TEXT"
7783
+ "button",
7784
+ "BUTTON"
7838
7785
  ],
7839
7786
  "type": "string",
7840
- "fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
7787
+ "fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
7841
7788
  },
7842
7789
  "key": {
7843
7790
  "pattern": "^[a-zA-Z0-9-]+$",
7844
7791
  "maxLength": 100,
7845
7792
  "type": "string",
7846
- "fieldDescription": "\n\nA key to identify this module.\n\n This key must be unique relative to the add on, with the exception of Confluence macros: Their keys need to be\n globally unique.\n\n Keys must only contain alphanumeric characters and dashes.\n\n The key is used to generate the url to your add-on's module. The url is generated as a combination of your add-on\n key and module key. For example, an add-on which looks like:\n\n {\n \"key\": \"my-addon\",\n \"modules\": {\n \"configurePage\": {\n \"key\": \"configure-me\",\n }\n }\n }\n\n Will have a configuration page module with a URL of `/plugins/servlet/ac/my-addon/configure-me`.\n\n"
7793
+ "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
7847
7794
  }
7848
7795
  },
7849
7796
  "required": [
7850
- "macroParameter",
7797
+ "label",
7851
7798
  "type",
7852
7799
  "key"
7853
7800
  ],
7854
- "shortClassName": "textControlBean",
7801
+ "additionalProperties": true,
7802
+ "shortClassName": "buttonControlBean",
7855
7803
  "type": "object",
7856
- "title": "TextControl",
7857
- "description": "\n\nDefines a text field which may appear in control extension points such as the property panel\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"type\": \"button\",\n \"label\": {\n \"value\": \"My Custom Control 0\"\n },\n \"key\": \"my-custom-control-0\"\n }\n\n\n"
7804
+ "title": "ButtonControl",
7805
+ "description": "\n\nDefines a button which may appear in control extension points such as the property panel\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"type\": \"button\",\n \"label\": {\n \"value\": \"My Custom Control 0\"\n },\n \"key\": \"my-custom-control-0\"\n }\n\n\n"
7858
7806
  },
7859
7807
  {
7860
7808
  "properties": {
@@ -7914,35 +7862,72 @@
7914
7862
  },
7915
7863
  {
7916
7864
  "properties": {
7917
- "label": {
7918
- "$ref": "#/definitions/i18nProperty",
7919
- "fieldDescription": "\n\nText which will appear inside the button\n\n"
7865
+ "controls": {
7866
+ "items": {
7867
+ "properties": {
7868
+ "macroParameterValue": {
7869
+ "maxLength": 10000,
7870
+ "type": "string",
7871
+ "fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n"
7872
+ },
7873
+ "label": {
7874
+ "$ref": "#/definitions/i18nProperty",
7875
+ "fieldDescription": "\n\nText which will appear inside the button\n\n"
7876
+ },
7877
+ "type": {
7878
+ "enum": [
7879
+ "togglebutton",
7880
+ "TOGGLEBUTTON"
7881
+ ],
7882
+ "type": "string",
7883
+ "fieldDescription": "\n\nThe type field must be set to 'togglebutton'\n\n"
7884
+ },
7885
+ "key": {
7886
+ "pattern": "^[a-zA-Z0-9-]+$",
7887
+ "maxLength": 100,
7888
+ "type": "string",
7889
+ "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
7890
+ }
7891
+ },
7892
+ "required": [
7893
+ "macroParameterValue",
7894
+ "label",
7895
+ "type",
7896
+ "key"
7897
+ ],
7898
+ "additionalProperties": true,
7899
+ "shortClassName": "macroToggleButtonControlBean",
7900
+ "type": "object",
7901
+ "title": "ToggleButtonControl",
7902
+ "description": "\n\nDefines a toggle button which appears inside a ToggleGroup\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"type\": \"togglebutton\",\n \"macroParameterValue\": \"macroParameterValue 0\",\n \"label\": {\n \"value\": \"My Custom Control 0\"\n },\n \"key\": \"my-custom-toggle-button-0\"\n }\n\n\n"
7903
+ },
7904
+ "type": "array",
7905
+ "fieldDescription": "\n\nToggle buttons which will appear in the toggle group\n\n"
7906
+ },
7907
+ "macroParameter": {
7908
+ "pattern": "[-_a-z0-9\\.]+",
7909
+ "maxLength": 100,
7910
+ "type": "string",
7911
+ "fieldDescription": "\n\nThe macro parameter identifier used to store the toggle state.\n It must only contain lowercase alphanumeric characters, dashes, underscores, dots and must not contain any spaces.\n\n"
7920
7912
  },
7921
7913
  "type": {
7922
7914
  "enum": [
7923
- "button",
7924
- "BUTTON"
7915
+ "togglegroup",
7916
+ "TOGGLEGROUP"
7925
7917
  ],
7926
7918
  "type": "string",
7927
- "fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
7928
- },
7929
- "key": {
7930
- "pattern": "^[a-zA-Z0-9-]+$",
7931
- "maxLength": 100,
7932
- "type": "string",
7933
- "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
7919
+ "fieldDescription": "\n\nThe type field must be set to 'togglegroup'\n\n"
7934
7920
  }
7935
7921
  },
7936
7922
  "required": [
7937
- "label",
7938
- "type",
7939
- "key"
7923
+ "controls",
7924
+ "macroParameter",
7925
+ "type"
7940
7926
  ],
7941
- "additionalProperties": true,
7942
- "shortClassName": "buttonControlBean",
7927
+ "shortClassName": "macroToggleGroupBean",
7943
7928
  "type": "object",
7944
- "title": "ButtonControl",
7945
- "description": "\n\nDefines a button which may appear in control extension points such as the property panel\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"type\": \"button\",\n \"label\": {\n \"value\": \"My Custom Control 0\"\n },\n \"key\": \"my-custom-control-0\"\n }\n\n\n"
7929
+ "title": "ToggleGroup",
7930
+ "description": "\n\nDefines a ToggleGroup which may appear in control extension points such as the property panel\n\n <p><b>Example</b></p>\n\n\n\n\n\n [\n {\n \"type\": \"togglegroup\",\n \"macroParameter\": \"toggleGroupMacroParameter\",\n \"controls\": [\n {\n \"type\": \"togglebutton\",\n \"macroParameterValue\": \"macroParameterValue 0\",\n \"label\": {\n \"value\": \"My Custom Control 0\"\n },\n \"key\": \"my-custom-toggle-button-0\"\n },\n {\n \"type\": \"togglebutton\",\n \"macroParameterValue\": \"macroParameterValue 1\",\n \"label\": {\n \"value\": \"My Custom Control 1\"\n },\n \"key\": \"my-custom-toggle-button-1\"\n }\n ]\n }\n ]\n\n\n"
7946
7931
  }
7947
7932
  ]
7948
7933
  },
@@ -8178,22 +8163,6 @@
8178
8163
  "type": "object",
8179
8164
  "fieldDescription": "\n\n<p>An object containing options which vary based on the type of web item target you are implementing.</p>\n\n <p>Currently-allowed options are:</p>\n <ul>\n <li><a href=\"../inline-dialog-options/\">Inline Dialog Options</a> when type is \"inlinedialog\", and</li>\n <li><a href=\"../dialog-options/\">Dialog Options</a> when type is \"dialog\"</li>\n <li><a href=\"../dialog-module-options/\">Dialog Module Options</a> when type is \"dialogmodule\"</li>\n </ul>\n\n",
8180
8165
  "anyOf": [
8181
- {
8182
- "properties": {
8183
- "key": {
8184
- "maxLength": 100,
8185
- "type": "string",
8186
- "fieldDescription": "\n\n<p>The key of a <a href=\"../dialog/\">Dialog</a> module declared in this Connect add-on.</p>\n\n <p>\n The dialog module will include the <a href=\"../dialog-options/\">Dialog Options</a>\n that would otherwise need to be specified directly in this options object.\n </p>\n\n"
8187
- }
8188
- },
8189
- "required": [
8190
- "key"
8191
- ],
8192
- "shortClassName": "dialogModuleOptions",
8193
- "type": "object",
8194
- "title": "Dialog Module Options",
8195
- "description": "\n\nOptions for a web-item targeting a common <a href=\"../dialog/\">dialog module</a>.\n\n <h3>Example</h3>\n\n\n\n\n\n {\n \"target\": {\n \"type\": \"dialogmodule\",\n \"options\": {\n \"key\": \"dialog-module-key\"\n }\n }\n }\n\n\n"
8196
- },
8197
8166
  {
8198
8167
  "properties": {
8199
8168
  "size": {
@@ -8239,6 +8208,22 @@
8239
8208
  "title": "Dialog Options",
8240
8209
  "description": "\n\nOptions for a modal dialog <a href=\"../web-item-target/\">web item target</a> or <a href=\"../dialog/\">common module</a>.\n\n <p>\n These options are a subset of those available via the <a href=\"../../jsapi/dialog/\">JavaScript API</a>.\n </p>\n\n <h2>Web Item Example</h2>\n\n\n\n\n\n {\n \"target\": {\n \"type\": \"dialog\",\n \"options\": {\n \"height\": \"100px\",\n \"width\": \"200px\"\n }\n }\n }\n\n\n\n\n <h2>Dialog Example</h2>\n\n\n\n\n\n {\n \"modules\": {\n \"dialogs\": [\n {\n \"url\": \"/my-dialog-content\",\n \"options\": {\n \"size\": \"fullscreen\",\n \"header\": {\n \"value\": \"Example Dialog\"\n }\n },\n \"key\": \"dialog-module-key\"\n }\n ]\n }\n }\n\n\n"
8241
8210
  },
8211
+ {
8212
+ "properties": {
8213
+ "key": {
8214
+ "maxLength": 100,
8215
+ "type": "string",
8216
+ "fieldDescription": "\n\n<p>The key of a <a href=\"../dialog/\">Dialog</a> module declared in this Connect add-on.</p>\n\n <p>\n The dialog module will include the <a href=\"../dialog-options/\">Dialog Options</a>\n that would otherwise need to be specified directly in this options object.\n </p>\n\n"
8217
+ }
8218
+ },
8219
+ "required": [
8220
+ "key"
8221
+ ],
8222
+ "shortClassName": "dialogModuleOptions",
8223
+ "type": "object",
8224
+ "title": "Dialog Module Options",
8225
+ "description": "\n\nOptions for a web-item targeting a common <a href=\"../dialog/\">dialog module</a>.\n\n <h3>Example</h3>\n\n\n\n\n\n {\n \"target\": {\n \"type\": \"dialogmodule\",\n \"options\": {\n \"key\": \"dialog-module-key\"\n }\n }\n }\n\n\n"
8226
+ },
8242
8227
  {
8243
8228
  "properties": {
8244
8229
  "offsetX": {
@@ -9582,10 +9567,10 @@
9582
9567
  "type": "object",
9583
9568
  "anyOf": [
9584
9569
  {
9585
- "$ref": "#/definitions/singleCondition"
9570
+ "$ref": "#"
9586
9571
  },
9587
9572
  {
9588
- "$ref": "#"
9573
+ "$ref": "#/definitions/singleCondition"
9589
9574
  }
9590
9575
  ]
9591
9576
  },