@forge/manifest 2.4.0-next.9 → 2.5.0-next.10

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.
@@ -2488,6 +2488,196 @@
2488
2488
  },
2489
2489
  "minItems": 1
2490
2490
  },
2491
+ "jira:globalPage": {
2492
+ "type": "array",
2493
+ "items": {
2494
+ "oneOf": [
2495
+ {
2496
+ "type": "object",
2497
+ "properties": {
2498
+ "function": {
2499
+ "type": "string",
2500
+ "minLength": 1,
2501
+ "maxLength": 255,
2502
+ "pattern": "^[a-zA-Z0-9-_]+$"
2503
+ },
2504
+ "title": {
2505
+ "minLength": 1,
2506
+ "maxLength": 255,
2507
+ "type": "string"
2508
+ },
2509
+ "icon": {
2510
+ "type": "string",
2511
+ "minLength": 1,
2512
+ "maxLength": 255
2513
+ },
2514
+ "layout": {
2515
+ "enum": [
2516
+ "basic",
2517
+ "native"
2518
+ ],
2519
+ "type": "string"
2520
+ },
2521
+ "key": {
2522
+ "$ref": "#/definitions/ModuleKeySchema"
2523
+ }
2524
+ },
2525
+ "required": [
2526
+ "function",
2527
+ "title",
2528
+ "key"
2529
+ ]
2530
+ },
2531
+ {
2532
+ "type": "object",
2533
+ "properties": {
2534
+ "resource": {
2535
+ "type": "string",
2536
+ "minLength": 1,
2537
+ "maxLength": 23,
2538
+ "pattern": "^[a-zA-Z0-9_\\-]+$"
2539
+ },
2540
+ "resolver": {
2541
+ "additionalProperties": false,
2542
+ "type": "object",
2543
+ "properties": {
2544
+ "function": {
2545
+ "type": "string",
2546
+ "minLength": 1,
2547
+ "maxLength": 255,
2548
+ "pattern": "^[a-zA-Z0-9-_]+$"
2549
+ }
2550
+ },
2551
+ "required": [
2552
+ "function"
2553
+ ]
2554
+ },
2555
+ "title": {
2556
+ "minLength": 1,
2557
+ "maxLength": 255,
2558
+ "type": "string"
2559
+ },
2560
+ "icon": {
2561
+ "type": "string",
2562
+ "minLength": 1,
2563
+ "maxLength": 255
2564
+ },
2565
+ "layout": {
2566
+ "enum": [
2567
+ "basic",
2568
+ "native"
2569
+ ],
2570
+ "type": "string"
2571
+ },
2572
+ "key": {
2573
+ "$ref": "#/definitions/ModuleKeySchema"
2574
+ }
2575
+ },
2576
+ "required": [
2577
+ "resource",
2578
+ "title",
2579
+ "key"
2580
+ ]
2581
+ }
2582
+ ]
2583
+ },
2584
+ "minItems": 1
2585
+ },
2586
+ "jira:projectSettingsPage": {
2587
+ "type": "array",
2588
+ "items": {
2589
+ "oneOf": [
2590
+ {
2591
+ "type": "object",
2592
+ "properties": {
2593
+ "function": {
2594
+ "type": "string",
2595
+ "minLength": 1,
2596
+ "maxLength": 255,
2597
+ "pattern": "^[a-zA-Z0-9-_]+$"
2598
+ },
2599
+ "title": {
2600
+ "minLength": 1,
2601
+ "maxLength": 255,
2602
+ "type": "string"
2603
+ },
2604
+ "icon": {
2605
+ "type": "string",
2606
+ "minLength": 1,
2607
+ "maxLength": 255
2608
+ },
2609
+ "layout": {
2610
+ "enum": [
2611
+ "basic",
2612
+ "native"
2613
+ ],
2614
+ "type": "string"
2615
+ },
2616
+ "key": {
2617
+ "$ref": "#/definitions/ModuleKeySchema"
2618
+ }
2619
+ },
2620
+ "required": [
2621
+ "function",
2622
+ "title",
2623
+ "key"
2624
+ ]
2625
+ },
2626
+ {
2627
+ "type": "object",
2628
+ "properties": {
2629
+ "resource": {
2630
+ "type": "string",
2631
+ "minLength": 1,
2632
+ "maxLength": 23,
2633
+ "pattern": "^[a-zA-Z0-9_\\-]+$"
2634
+ },
2635
+ "resolver": {
2636
+ "additionalProperties": false,
2637
+ "type": "object",
2638
+ "properties": {
2639
+ "function": {
2640
+ "type": "string",
2641
+ "minLength": 1,
2642
+ "maxLength": 255,
2643
+ "pattern": "^[a-zA-Z0-9-_]+$"
2644
+ }
2645
+ },
2646
+ "required": [
2647
+ "function"
2648
+ ]
2649
+ },
2650
+ "title": {
2651
+ "minLength": 1,
2652
+ "maxLength": 255,
2653
+ "type": "string"
2654
+ },
2655
+ "icon": {
2656
+ "type": "string",
2657
+ "minLength": 1,
2658
+ "maxLength": 255
2659
+ },
2660
+ "layout": {
2661
+ "enum": [
2662
+ "basic",
2663
+ "native"
2664
+ ],
2665
+ "type": "string"
2666
+ },
2667
+ "key": {
2668
+ "$ref": "#/definitions/ModuleKeySchema"
2669
+ }
2670
+ },
2671
+ "required": [
2672
+ "resource",
2673
+ "title",
2674
+ "key"
2675
+ ]
2676
+ }
2677
+ ]
2678
+ },
2679
+ "minItems": 1
2680
+ },
2491
2681
  "compass:adminPage": {
2492
2682
  "type": "array",
2493
2683
  "items": {
@@ -5166,10 +5356,10 @@
5166
5356
  "type": "object",
5167
5357
  "anyOf": [
5168
5358
  {
5169
- "$ref": "#/definitions/compositeCondition"
5359
+ "$ref": "#/definitions/singleCondition"
5170
5360
  },
5171
5361
  {
5172
- "$ref": "#/definitions/singleCondition"
5362
+ "$ref": "#/definitions/compositeCondition"
5173
5363
  }
5174
5364
  ]
5175
5365
  },
@@ -5237,10 +5427,10 @@
5237
5427
  "type": "object",
5238
5428
  "anyOf": [
5239
5429
  {
5240
- "$ref": "#/definitions/compositeCondition"
5430
+ "$ref": "#/definitions/singleCondition"
5241
5431
  },
5242
5432
  {
5243
- "$ref": "#/definitions/singleCondition"
5433
+ "$ref": "#/definitions/compositeCondition"
5244
5434
  }
5245
5435
  ]
5246
5436
  },
@@ -5356,10 +5546,10 @@
5356
5546
  "type": "object",
5357
5547
  "anyOf": [
5358
5548
  {
5359
- "$ref": "#/definitions/singleCondition"
5549
+ "$ref": "#/definitions/compositeCondition"
5360
5550
  },
5361
5551
  {
5362
- "$ref": "#/definitions/compositeCondition"
5552
+ "$ref": "#/definitions/singleCondition"
5363
5553
  }
5364
5554
  ]
5365
5555
  },
@@ -5414,10 +5604,10 @@
5414
5604
  "type": "object",
5415
5605
  "anyOf": [
5416
5606
  {
5417
- "$ref": "#/definitions/compositeCondition"
5607
+ "$ref": "#/definitions/singleCondition"
5418
5608
  },
5419
5609
  {
5420
- "$ref": "#/definitions/singleCondition"
5610
+ "$ref": "#/definitions/compositeCondition"
5421
5611
  }
5422
5612
  ]
5423
5613
  },
@@ -5472,10 +5662,10 @@
5472
5662
  "type": "object",
5473
5663
  "anyOf": [
5474
5664
  {
5475
- "$ref": "#/definitions/singleCondition"
5665
+ "$ref": "#/definitions/compositeCondition"
5476
5666
  },
5477
5667
  {
5478
- "$ref": "#/definitions/compositeCondition"
5668
+ "$ref": "#/definitions/singleCondition"
5479
5669
  }
5480
5670
  ]
5481
5671
  },
@@ -5545,51 +5735,6 @@
5545
5735
  "type": "object",
5546
5736
  "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",
5547
5737
  "anyOf": [
5548
- {
5549
- "properties": {
5550
- "size": {
5551
- "enum": [
5552
- "small",
5553
- "SMALL",
5554
- "medium",
5555
- "MEDIUM",
5556
- "large",
5557
- "LARGE",
5558
- "x-large",
5559
- "X-LARGE",
5560
- "fullscreen",
5561
- "FULLSCREEN",
5562
- "maximum",
5563
- "MAXIMUM"
5564
- ],
5565
- "type": "string",
5566
- "fieldDescription": "\n\nSets the size of the dialog.\n\n <p>\n This option is used instead of the 'height' and 'width' options.\n </p>\n\n"
5567
- },
5568
- "chrome": {
5569
- "type": "boolean",
5570
- "fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
5571
- "defaultValue": "true"
5572
- },
5573
- "width": {
5574
- "maxLength": 10,
5575
- "type": "string",
5576
- "fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
5577
- },
5578
- "header": {
5579
- "$ref": "#/definitions/i18nProperty",
5580
- "fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
5581
- },
5582
- "height": {
5583
- "maxLength": 10,
5584
- "type": "string",
5585
- "fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
5586
- }
5587
- },
5588
- "shortClassName": "dialogOptions",
5589
- "type": "object",
5590
- "title": "Dialog Options",
5591
- "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"
5592
- },
5593
5738
  {
5594
5739
  "properties": {
5595
5740
  "offsetX": {
@@ -5639,17 +5784,62 @@
5639
5784
  },
5640
5785
  {
5641
5786
  "properties": {
5642
- "key": {
5643
- "maxLength": 100,
5644
- "type": "string",
5645
- "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"
5646
- }
5647
- },
5648
- "required": [
5649
- "key"
5650
- ],
5651
- "shortClassName": "dialogModuleOptions",
5652
- "type": "object",
5787
+ "size": {
5788
+ "enum": [
5789
+ "small",
5790
+ "SMALL",
5791
+ "medium",
5792
+ "MEDIUM",
5793
+ "large",
5794
+ "LARGE",
5795
+ "x-large",
5796
+ "X-LARGE",
5797
+ "fullscreen",
5798
+ "FULLSCREEN",
5799
+ "maximum",
5800
+ "MAXIMUM"
5801
+ ],
5802
+ "type": "string",
5803
+ "fieldDescription": "\n\nSets the size of the dialog.\n\n <p>\n This option is used instead of the 'height' and 'width' options.\n </p>\n\n"
5804
+ },
5805
+ "chrome": {
5806
+ "type": "boolean",
5807
+ "fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
5808
+ "defaultValue": "true"
5809
+ },
5810
+ "width": {
5811
+ "maxLength": 10,
5812
+ "type": "string",
5813
+ "fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
5814
+ },
5815
+ "header": {
5816
+ "$ref": "#/definitions/i18nProperty",
5817
+ "fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
5818
+ },
5819
+ "height": {
5820
+ "maxLength": 10,
5821
+ "type": "string",
5822
+ "fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
5823
+ }
5824
+ },
5825
+ "shortClassName": "dialogOptions",
5826
+ "type": "object",
5827
+ "title": "Dialog Options",
5828
+ "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"
5829
+ },
5830
+ {
5831
+ "properties": {
5832
+ "key": {
5833
+ "maxLength": 100,
5834
+ "type": "string",
5835
+ "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"
5836
+ }
5837
+ },
5838
+ "required": [
5839
+ "key"
5840
+ ],
5841
+ "shortClassName": "dialogModuleOptions",
5842
+ "type": "object",
5653
5843
  "title": "Dialog Module Options",
5654
5844
  "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"
5655
5845
  }
@@ -5820,10 +6010,10 @@
5820
6010
  "type": "object",
5821
6011
  "anyOf": [
5822
6012
  {
5823
- "$ref": "#/definitions/compositeCondition"
6013
+ "$ref": "#/definitions/singleCondition"
5824
6014
  },
5825
6015
  {
5826
- "$ref": "#/definitions/singleCondition"
6016
+ "$ref": "#/definitions/compositeCondition"
5827
6017
  }
5828
6018
  ]
5829
6019
  },
@@ -5971,6 +6161,33 @@
5971
6161
  "items": {
5972
6162
  "type": "object",
5973
6163
  "anyOf": [
6164
+ {
6165
+ "properties": {
6166
+ "condition": {
6167
+ "maxLength": 100,
6168
+ "type": "string",
6169
+ "fieldDescription": "\n\nA string indicating the name of the condition\n\n"
6170
+ },
6171
+ "invert": {
6172
+ "type": "boolean",
6173
+ "fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
6174
+ "defaultValue": "false"
6175
+ },
6176
+ "params": {
6177
+ "additionalProperties": true,
6178
+ "type": "object",
6179
+ "fieldTitle": "Object",
6180
+ "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"
6181
+ }
6182
+ },
6183
+ "required": [
6184
+ "condition"
6185
+ ],
6186
+ "shortClassName": "singleConditionBean",
6187
+ "type": "object",
6188
+ "title": "Single Condition",
6189
+ "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"
6190
+ },
5974
6191
  {
5975
6192
  "properties": {
5976
6193
  "conditions": {
@@ -5978,10 +6195,10 @@
5978
6195
  "type": "object",
5979
6196
  "anyOf": [
5980
6197
  {
5981
- "$ref": "#/definitions/singleCondition"
6198
+ "$ref": "#"
5982
6199
  },
5983
6200
  {
5984
- "$ref": "#"
6201
+ "$ref": "#/definitions/singleCondition"
5985
6202
  }
5986
6203
  ]
5987
6204
  },
@@ -6003,33 +6220,6 @@
6003
6220
  "type": "object",
6004
6221
  "title": "Composite Condition",
6005
6222
  "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"
6006
- },
6007
- {
6008
- "properties": {
6009
- "condition": {
6010
- "maxLength": 100,
6011
- "type": "string",
6012
- "fieldDescription": "\n\nA string indicating the name of the condition\n\n"
6013
- },
6014
- "invert": {
6015
- "type": "boolean",
6016
- "fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
6017
- "defaultValue": "false"
6018
- },
6019
- "params": {
6020
- "additionalProperties": true,
6021
- "type": "object",
6022
- "fieldTitle": "Object",
6023
- "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"
6024
- }
6025
- },
6026
- "required": [
6027
- "condition"
6028
- ],
6029
- "shortClassName": "singleConditionBean",
6030
- "type": "object",
6031
- "title": "Single Condition",
6032
- "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"
6033
6223
  }
6034
6224
  ]
6035
6225
  },
@@ -6335,6 +6525,38 @@
6335
6525
  "title": "TextControl",
6336
6526
  "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"
6337
6527
  },
6528
+ {
6529
+ "properties": {
6530
+ "label": {
6531
+ "$ref": "#/definitions/i18nProperty",
6532
+ "fieldDescription": "\n\nText which will appear inside the button\n\n"
6533
+ },
6534
+ "type": {
6535
+ "enum": [
6536
+ "button",
6537
+ "BUTTON"
6538
+ ],
6539
+ "type": "string",
6540
+ "fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
6541
+ },
6542
+ "key": {
6543
+ "pattern": "^[a-zA-Z0-9-]+$",
6544
+ "maxLength": 100,
6545
+ "type": "string",
6546
+ "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
6547
+ }
6548
+ },
6549
+ "required": [
6550
+ "label",
6551
+ "type",
6552
+ "key"
6553
+ ],
6554
+ "additionalProperties": true,
6555
+ "shortClassName": "buttonControlBean",
6556
+ "type": "object",
6557
+ "title": "ButtonControl",
6558
+ "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"
6559
+ },
6338
6560
  {
6339
6561
  "properties": {
6340
6562
  "controls": {
@@ -6391,38 +6613,6 @@
6391
6613
  "title": "ControlGroup",
6392
6614
  "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"
6393
6615
  },
6394
- {
6395
- "properties": {
6396
- "label": {
6397
- "$ref": "#/definitions/i18nProperty",
6398
- "fieldDescription": "\n\nText which will appear inside the button\n\n"
6399
- },
6400
- "type": {
6401
- "enum": [
6402
- "button",
6403
- "BUTTON"
6404
- ],
6405
- "type": "string",
6406
- "fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
6407
- },
6408
- "key": {
6409
- "pattern": "^[a-zA-Z0-9-]+$",
6410
- "maxLength": 100,
6411
- "type": "string",
6412
- "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
6413
- }
6414
- },
6415
- "required": [
6416
- "label",
6417
- "type",
6418
- "key"
6419
- ],
6420
- "additionalProperties": true,
6421
- "shortClassName": "buttonControlBean",
6422
- "type": "object",
6423
- "title": "ButtonControl",
6424
- "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"
6425
- },
6426
6616
  {
6427
6617
  "properties": {
6428
6618
  "controls": {
@@ -6787,35 +6977,72 @@
6787
6977
  "anyOf": [
6788
6978
  {
6789
6979
  "properties": {
6790
- "label": {
6791
- "$ref": "#/definitions/i18nProperty",
6792
- "fieldDescription": "\n\nText which will appear inside the button\n\n"
6980
+ "controls": {
6981
+ "items": {
6982
+ "properties": {
6983
+ "macroParameterValue": {
6984
+ "maxLength": 10000,
6985
+ "type": "string",
6986
+ "fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n"
6987
+ },
6988
+ "label": {
6989
+ "$ref": "#/definitions/i18nProperty",
6990
+ "fieldDescription": "\n\nText which will appear inside the button\n\n"
6991
+ },
6992
+ "type": {
6993
+ "enum": [
6994
+ "togglebutton",
6995
+ "TOGGLEBUTTON"
6996
+ ],
6997
+ "type": "string",
6998
+ "fieldDescription": "\n\nThe type field must be set to 'togglebutton'\n\n"
6999
+ },
7000
+ "key": {
7001
+ "pattern": "^[a-zA-Z0-9-]+$",
7002
+ "maxLength": 100,
7003
+ "type": "string",
7004
+ "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
7005
+ }
7006
+ },
7007
+ "required": [
7008
+ "macroParameterValue",
7009
+ "label",
7010
+ "type",
7011
+ "key"
7012
+ ],
7013
+ "additionalProperties": true,
7014
+ "shortClassName": "macroToggleButtonControlBean",
7015
+ "type": "object",
7016
+ "title": "ToggleButtonControl",
7017
+ "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"
7018
+ },
7019
+ "type": "array",
7020
+ "fieldDescription": "\n\nToggle buttons which will appear in the toggle group\n\n"
7021
+ },
7022
+ "macroParameter": {
7023
+ "pattern": "[-_a-z0-9\\.]+",
7024
+ "maxLength": 100,
7025
+ "type": "string",
7026
+ "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"
6793
7027
  },
6794
7028
  "type": {
6795
7029
  "enum": [
6796
- "button",
6797
- "BUTTON"
7030
+ "togglegroup",
7031
+ "TOGGLEGROUP"
6798
7032
  ],
6799
7033
  "type": "string",
6800
- "fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
6801
- },
6802
- "key": {
6803
- "pattern": "^[a-zA-Z0-9-]+$",
6804
- "maxLength": 100,
6805
- "type": "string",
6806
- "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
7034
+ "fieldDescription": "\n\nThe type field must be set to 'togglegroup'\n\n"
6807
7035
  }
6808
7036
  },
6809
7037
  "required": [
6810
- "label",
6811
- "type",
6812
- "key"
7038
+ "controls",
7039
+ "macroParameter",
7040
+ "type"
6813
7041
  ],
6814
- "additionalProperties": true,
6815
- "shortClassName": "buttonControlBean",
7042
+ "shortClassName": "macroToggleGroupBean",
6816
7043
  "type": "object",
6817
- "title": "ButtonControl",
6818
- "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"
7044
+ "title": "ToggleGroup",
7045
+ "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"
6819
7046
  },
6820
7047
  {
6821
7048
  "properties": {
@@ -6907,72 +7134,35 @@
6907
7134
  },
6908
7135
  {
6909
7136
  "properties": {
6910
- "controls": {
6911
- "items": {
6912
- "properties": {
6913
- "macroParameterValue": {
6914
- "maxLength": 10000,
6915
- "type": "string",
6916
- "fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n"
6917
- },
6918
- "label": {
6919
- "$ref": "#/definitions/i18nProperty",
6920
- "fieldDescription": "\n\nText which will appear inside the button\n\n"
6921
- },
6922
- "type": {
6923
- "enum": [
6924
- "togglebutton",
6925
- "TOGGLEBUTTON"
6926
- ],
6927
- "type": "string",
6928
- "fieldDescription": "\n\nThe type field must be set to 'togglebutton'\n\n"
6929
- },
6930
- "key": {
6931
- "pattern": "^[a-zA-Z0-9-]+$",
6932
- "maxLength": 100,
6933
- "type": "string",
6934
- "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
6935
- }
6936
- },
6937
- "required": [
6938
- "macroParameterValue",
6939
- "label",
6940
- "type",
6941
- "key"
6942
- ],
6943
- "additionalProperties": true,
6944
- "shortClassName": "macroToggleButtonControlBean",
6945
- "type": "object",
6946
- "title": "ToggleButtonControl",
6947
- "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"
6948
- },
6949
- "type": "array",
6950
- "fieldDescription": "\n\nToggle buttons which will appear in the toggle group\n\n"
6951
- },
6952
- "macroParameter": {
6953
- "pattern": "[-_a-z0-9\\.]+",
6954
- "maxLength": 100,
6955
- "type": "string",
6956
- "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"
7137
+ "label": {
7138
+ "$ref": "#/definitions/i18nProperty",
7139
+ "fieldDescription": "\n\nText which will appear inside the button\n\n"
6957
7140
  },
6958
7141
  "type": {
6959
7142
  "enum": [
6960
- "togglegroup",
6961
- "TOGGLEGROUP"
7143
+ "button",
7144
+ "BUTTON"
6962
7145
  ],
6963
7146
  "type": "string",
6964
- "fieldDescription": "\n\nThe type field must be set to 'togglegroup'\n\n"
7147
+ "fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
7148
+ },
7149
+ "key": {
7150
+ "pattern": "^[a-zA-Z0-9-]+$",
7151
+ "maxLength": 100,
7152
+ "type": "string",
7153
+ "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
6965
7154
  }
6966
7155
  },
6967
7156
  "required": [
6968
- "controls",
6969
- "macroParameter",
6970
- "type"
7157
+ "label",
7158
+ "type",
7159
+ "key"
6971
7160
  ],
6972
- "shortClassName": "macroToggleGroupBean",
7161
+ "additionalProperties": true,
7162
+ "shortClassName": "buttonControlBean",
6973
7163
  "type": "object",
6974
- "title": "ToggleGroup",
6975
- "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"
7164
+ "title": "ButtonControl",
7165
+ "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"
6976
7166
  }
6977
7167
  ]
6978
7168
  },
@@ -7224,51 +7414,6 @@
7224
7414
  "title": "Dialog Module Options",
7225
7415
  "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"
7226
7416
  },
7227
- {
7228
- "properties": {
7229
- "size": {
7230
- "enum": [
7231
- "small",
7232
- "SMALL",
7233
- "medium",
7234
- "MEDIUM",
7235
- "large",
7236
- "LARGE",
7237
- "x-large",
7238
- "X-LARGE",
7239
- "fullscreen",
7240
- "FULLSCREEN",
7241
- "maximum",
7242
- "MAXIMUM"
7243
- ],
7244
- "type": "string",
7245
- "fieldDescription": "\n\nSets the size of the dialog.\n\n <p>\n This option is used instead of the 'height' and 'width' options.\n </p>\n\n"
7246
- },
7247
- "chrome": {
7248
- "type": "boolean",
7249
- "fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
7250
- "defaultValue": "true"
7251
- },
7252
- "width": {
7253
- "maxLength": 10,
7254
- "type": "string",
7255
- "fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
7256
- },
7257
- "header": {
7258
- "$ref": "#/definitions/i18nProperty",
7259
- "fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
7260
- },
7261
- "height": {
7262
- "maxLength": 10,
7263
- "type": "string",
7264
- "fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
7265
- }
7266
- },
7267
- "shortClassName": "dialogOptions",
7268
- "type": "object",
7269
- "title": "Dialog Options",
7270
- "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"
7271
- },
7272
7417
  {
7273
7418
  "properties": {
7274
7419
  "offsetX": {
@@ -7315,6 +7460,51 @@
7315
7460
  "type": "object",
7316
7461
  "title": "Inline Dialog Options",
7317
7462
  "description": "\n\nOptions for an inline dialog target\n\n <h3>Example</h3>\n\n\n\n\n\n {\n \"target\": {\n \"type\": \"inlinedialog\",\n \"options\": {\n \"onHover\": true,\n \"offsetX\": \"30px\",\n \"offsetY\": \"20px\"\n }\n }\n }\n\n\n"
7463
+ },
7464
+ {
7465
+ "properties": {
7466
+ "size": {
7467
+ "enum": [
7468
+ "small",
7469
+ "SMALL",
7470
+ "medium",
7471
+ "MEDIUM",
7472
+ "large",
7473
+ "LARGE",
7474
+ "x-large",
7475
+ "X-LARGE",
7476
+ "fullscreen",
7477
+ "FULLSCREEN",
7478
+ "maximum",
7479
+ "MAXIMUM"
7480
+ ],
7481
+ "type": "string",
7482
+ "fieldDescription": "\n\nSets the size of the dialog.\n\n <p>\n This option is used instead of the 'height' and 'width' options.\n </p>\n\n"
7483
+ },
7484
+ "chrome": {
7485
+ "type": "boolean",
7486
+ "fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
7487
+ "defaultValue": "true"
7488
+ },
7489
+ "width": {
7490
+ "maxLength": 10,
7491
+ "type": "string",
7492
+ "fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
7493
+ },
7494
+ "header": {
7495
+ "$ref": "#/definitions/i18nProperty",
7496
+ "fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
7497
+ },
7498
+ "height": {
7499
+ "maxLength": 10,
7500
+ "type": "string",
7501
+ "fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
7502
+ }
7503
+ },
7504
+ "shortClassName": "dialogOptions",
7505
+ "type": "object",
7506
+ "title": "Dialog Options",
7507
+ "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"
7318
7508
  }
7319
7509
  ]
7320
7510
  },
@@ -8600,10 +8790,10 @@
8600
8790
  "type": "object",
8601
8791
  "anyOf": [
8602
8792
  {
8603
- "$ref": "#/definitions/singleCondition"
8793
+ "$ref": "#"
8604
8794
  },
8605
8795
  {
8606
- "$ref": "#"
8796
+ "$ref": "#/definitions/singleCondition"
8607
8797
  }
8608
8798
  ]
8609
8799
  },