@forge/manifest 2.5.0-next.1 → 2.5.0-next.5
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.
- package/CHANGELOG.md +25 -0
- package/out/mapping/product-event-to-scope-mapping.json +42 -0
- package/out/schema/manifest-schema.json +372 -182
- package/out/schema/manifest.d.ts +282 -194
- package/package.json +1 -1
|
@@ -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/
|
|
5359
|
+
"$ref": "#/definitions/compositeCondition"
|
|
5170
5360
|
},
|
|
5171
5361
|
{
|
|
5172
|
-
"$ref": "#/definitions/
|
|
5362
|
+
"$ref": "#/definitions/singleCondition"
|
|
5173
5363
|
}
|
|
5174
5364
|
]
|
|
5175
5365
|
},
|
|
@@ -5292,10 +5482,10 @@
|
|
|
5292
5482
|
"type": "object",
|
|
5293
5483
|
"anyOf": [
|
|
5294
5484
|
{
|
|
5295
|
-
"$ref": "#/definitions/
|
|
5485
|
+
"$ref": "#/definitions/singleCondition"
|
|
5296
5486
|
},
|
|
5297
5487
|
{
|
|
5298
|
-
"$ref": "#/definitions/
|
|
5488
|
+
"$ref": "#/definitions/compositeCondition"
|
|
5299
5489
|
}
|
|
5300
5490
|
]
|
|
5301
5491
|
},
|
|
@@ -5545,67 +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
|
-
{
|
|
5594
|
-
"properties": {
|
|
5595
|
-
"key": {
|
|
5596
|
-
"maxLength": 100,
|
|
5597
|
-
"type": "string",
|
|
5598
|
-
"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"
|
|
5599
|
-
}
|
|
5600
|
-
},
|
|
5601
|
-
"required": [
|
|
5602
|
-
"key"
|
|
5603
|
-
],
|
|
5604
|
-
"shortClassName": "dialogModuleOptions",
|
|
5605
|
-
"type": "object",
|
|
5606
|
-
"title": "Dialog Module Options",
|
|
5607
|
-
"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"
|
|
5608
|
-
},
|
|
5609
5738
|
{
|
|
5610
5739
|
"properties": {
|
|
5611
5740
|
"offsetX": {
|
|
@@ -5652,13 +5781,74 @@
|
|
|
5652
5781
|
"type": "object",
|
|
5653
5782
|
"title": "Inline Dialog Options",
|
|
5654
5783
|
"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"
|
|
5655
|
-
}
|
|
5656
|
-
|
|
5657
|
-
|
|
5658
|
-
|
|
5659
|
-
|
|
5660
|
-
|
|
5661
|
-
|
|
5784
|
+
},
|
|
5785
|
+
{
|
|
5786
|
+
"properties": {
|
|
5787
|
+
"key": {
|
|
5788
|
+
"maxLength": 100,
|
|
5789
|
+
"type": "string",
|
|
5790
|
+
"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"
|
|
5791
|
+
}
|
|
5792
|
+
},
|
|
5793
|
+
"required": [
|
|
5794
|
+
"key"
|
|
5795
|
+
],
|
|
5796
|
+
"shortClassName": "dialogModuleOptions",
|
|
5797
|
+
"type": "object",
|
|
5798
|
+
"title": "Dialog Module Options",
|
|
5799
|
+
"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"
|
|
5800
|
+
},
|
|
5801
|
+
{
|
|
5802
|
+
"properties": {
|
|
5803
|
+
"size": {
|
|
5804
|
+
"enum": [
|
|
5805
|
+
"small",
|
|
5806
|
+
"SMALL",
|
|
5807
|
+
"medium",
|
|
5808
|
+
"MEDIUM",
|
|
5809
|
+
"large",
|
|
5810
|
+
"LARGE",
|
|
5811
|
+
"x-large",
|
|
5812
|
+
"X-LARGE",
|
|
5813
|
+
"fullscreen",
|
|
5814
|
+
"FULLSCREEN",
|
|
5815
|
+
"maximum",
|
|
5816
|
+
"MAXIMUM"
|
|
5817
|
+
],
|
|
5818
|
+
"type": "string",
|
|
5819
|
+
"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"
|
|
5820
|
+
},
|
|
5821
|
+
"chrome": {
|
|
5822
|
+
"type": "boolean",
|
|
5823
|
+
"fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
|
|
5824
|
+
"defaultValue": "true"
|
|
5825
|
+
},
|
|
5826
|
+
"width": {
|
|
5827
|
+
"maxLength": 10,
|
|
5828
|
+
"type": "string",
|
|
5829
|
+
"fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
|
|
5830
|
+
},
|
|
5831
|
+
"header": {
|
|
5832
|
+
"$ref": "#/definitions/i18nProperty",
|
|
5833
|
+
"fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
|
|
5834
|
+
},
|
|
5835
|
+
"height": {
|
|
5836
|
+
"maxLength": 10,
|
|
5837
|
+
"type": "string",
|
|
5838
|
+
"fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
|
|
5839
|
+
}
|
|
5840
|
+
},
|
|
5841
|
+
"shortClassName": "dialogOptions",
|
|
5842
|
+
"type": "object",
|
|
5843
|
+
"title": "Dialog Options",
|
|
5844
|
+
"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"
|
|
5845
|
+
}
|
|
5846
|
+
]
|
|
5847
|
+
},
|
|
5848
|
+
"type": {
|
|
5849
|
+
"enum": [
|
|
5850
|
+
"page",
|
|
5851
|
+
"PAGE",
|
|
5662
5852
|
"dialog",
|
|
5663
5853
|
"DIALOG",
|
|
5664
5854
|
"inlinedialog",
|
|
@@ -5742,10 +5932,10 @@
|
|
|
5742
5932
|
"type": "object",
|
|
5743
5933
|
"anyOf": [
|
|
5744
5934
|
{
|
|
5745
|
-
"$ref": "
|
|
5935
|
+
"$ref": "#/definitions/singleCondition"
|
|
5746
5936
|
},
|
|
5747
5937
|
{
|
|
5748
|
-
"$ref": "
|
|
5938
|
+
"$ref": "#"
|
|
5749
5939
|
}
|
|
5750
5940
|
]
|
|
5751
5941
|
},
|
|
@@ -5820,10 +6010,10 @@
|
|
|
5820
6010
|
"type": "object",
|
|
5821
6011
|
"anyOf": [
|
|
5822
6012
|
{
|
|
5823
|
-
"$ref": "#/definitions/
|
|
6013
|
+
"$ref": "#/definitions/compositeCondition"
|
|
5824
6014
|
},
|
|
5825
6015
|
{
|
|
5826
|
-
"$ref": "#/definitions/
|
|
6016
|
+
"$ref": "#/definitions/singleCondition"
|
|
5827
6017
|
}
|
|
5828
6018
|
]
|
|
5829
6019
|
},
|
|
@@ -6335,38 +6525,6 @@
|
|
|
6335
6525
|
"title": "ButtonControl",
|
|
6336
6526
|
"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"
|
|
6337
6527
|
},
|
|
6338
|
-
{
|
|
6339
|
-
"properties": {
|
|
6340
|
-
"macroParameter": {
|
|
6341
|
-
"maxLength": 100,
|
|
6342
|
-
"type": "string",
|
|
6343
|
-
"fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
|
|
6344
|
-
},
|
|
6345
|
-
"type": {
|
|
6346
|
-
"enum": [
|
|
6347
|
-
"text",
|
|
6348
|
-
"TEXT"
|
|
6349
|
-
],
|
|
6350
|
-
"type": "string",
|
|
6351
|
-
"fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
|
|
6352
|
-
},
|
|
6353
|
-
"key": {
|
|
6354
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
6355
|
-
"maxLength": 100,
|
|
6356
|
-
"type": "string",
|
|
6357
|
-
"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"
|
|
6358
|
-
}
|
|
6359
|
-
},
|
|
6360
|
-
"required": [
|
|
6361
|
-
"macroParameter",
|
|
6362
|
-
"type",
|
|
6363
|
-
"key"
|
|
6364
|
-
],
|
|
6365
|
-
"shortClassName": "textControlBean",
|
|
6366
|
-
"type": "object",
|
|
6367
|
-
"title": "TextControl",
|
|
6368
|
-
"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"
|
|
6369
|
-
},
|
|
6370
6528
|
{
|
|
6371
6529
|
"properties": {
|
|
6372
6530
|
"controls": {
|
|
@@ -6491,6 +6649,38 @@
|
|
|
6491
6649
|
"type": "object",
|
|
6492
6650
|
"title": "ToggleGroup",
|
|
6493
6651
|
"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"
|
|
6652
|
+
},
|
|
6653
|
+
{
|
|
6654
|
+
"properties": {
|
|
6655
|
+
"macroParameter": {
|
|
6656
|
+
"maxLength": 100,
|
|
6657
|
+
"type": "string",
|
|
6658
|
+
"fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
|
|
6659
|
+
},
|
|
6660
|
+
"type": {
|
|
6661
|
+
"enum": [
|
|
6662
|
+
"text",
|
|
6663
|
+
"TEXT"
|
|
6664
|
+
],
|
|
6665
|
+
"type": "string",
|
|
6666
|
+
"fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
|
|
6667
|
+
},
|
|
6668
|
+
"key": {
|
|
6669
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
6670
|
+
"maxLength": 100,
|
|
6671
|
+
"type": "string",
|
|
6672
|
+
"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"
|
|
6673
|
+
}
|
|
6674
|
+
},
|
|
6675
|
+
"required": [
|
|
6676
|
+
"macroParameter",
|
|
6677
|
+
"type",
|
|
6678
|
+
"key"
|
|
6679
|
+
],
|
|
6680
|
+
"shortClassName": "textControlBean",
|
|
6681
|
+
"type": "object",
|
|
6682
|
+
"title": "TextControl",
|
|
6683
|
+
"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"
|
|
6494
6684
|
}
|
|
6495
6685
|
]
|
|
6496
6686
|
},
|
|
@@ -6817,6 +7007,62 @@
|
|
|
6817
7007
|
"title": "ButtonControl",
|
|
6818
7008
|
"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"
|
|
6819
7009
|
},
|
|
7010
|
+
{
|
|
7011
|
+
"properties": {
|
|
7012
|
+
"controls": {
|
|
7013
|
+
"items": {
|
|
7014
|
+
"properties": {
|
|
7015
|
+
"label": {
|
|
7016
|
+
"$ref": "#/definitions/i18nProperty",
|
|
7017
|
+
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
7018
|
+
},
|
|
7019
|
+
"type": {
|
|
7020
|
+
"enum": [
|
|
7021
|
+
"button",
|
|
7022
|
+
"BUTTON"
|
|
7023
|
+
],
|
|
7024
|
+
"type": "string",
|
|
7025
|
+
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
7026
|
+
},
|
|
7027
|
+
"key": {
|
|
7028
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
7029
|
+
"maxLength": 100,
|
|
7030
|
+
"type": "string",
|
|
7031
|
+
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
7032
|
+
}
|
|
7033
|
+
},
|
|
7034
|
+
"required": [
|
|
7035
|
+
"label",
|
|
7036
|
+
"type",
|
|
7037
|
+
"key"
|
|
7038
|
+
],
|
|
7039
|
+
"additionalProperties": true,
|
|
7040
|
+
"shortClassName": "buttonControlBean",
|
|
7041
|
+
"type": "object",
|
|
7042
|
+
"title": "ButtonControl",
|
|
7043
|
+
"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
|
+
},
|
|
7045
|
+
"type": "array",
|
|
7046
|
+
"fieldDescription": "\n\nControls which will appear in the control group\n\n"
|
|
7047
|
+
},
|
|
7048
|
+
"type": {
|
|
7049
|
+
"enum": [
|
|
7050
|
+
"group",
|
|
7051
|
+
"GROUP"
|
|
7052
|
+
],
|
|
7053
|
+
"type": "string",
|
|
7054
|
+
"fieldDescription": "\n\nThe type field must be set to 'group'\n\n"
|
|
7055
|
+
}
|
|
7056
|
+
},
|
|
7057
|
+
"required": [
|
|
7058
|
+
"controls",
|
|
7059
|
+
"type"
|
|
7060
|
+
],
|
|
7061
|
+
"shortClassName": "controlGroupBean",
|
|
7062
|
+
"type": "object",
|
|
7063
|
+
"title": "ControlGroup",
|
|
7064
|
+
"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"
|
|
7065
|
+
},
|
|
6820
7066
|
{
|
|
6821
7067
|
"properties": {
|
|
6822
7068
|
"macroParameter": {
|
|
@@ -6917,62 +7163,6 @@
|
|
|
6917
7163
|
"type": "object",
|
|
6918
7164
|
"title": "ToggleGroup",
|
|
6919
7165
|
"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"
|
|
6920
|
-
},
|
|
6921
|
-
{
|
|
6922
|
-
"properties": {
|
|
6923
|
-
"controls": {
|
|
6924
|
-
"items": {
|
|
6925
|
-
"properties": {
|
|
6926
|
-
"label": {
|
|
6927
|
-
"$ref": "#/definitions/i18nProperty",
|
|
6928
|
-
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
6929
|
-
},
|
|
6930
|
-
"type": {
|
|
6931
|
-
"enum": [
|
|
6932
|
-
"button",
|
|
6933
|
-
"BUTTON"
|
|
6934
|
-
],
|
|
6935
|
-
"type": "string",
|
|
6936
|
-
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
6937
|
-
},
|
|
6938
|
-
"key": {
|
|
6939
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
6940
|
-
"maxLength": 100,
|
|
6941
|
-
"type": "string",
|
|
6942
|
-
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
6943
|
-
}
|
|
6944
|
-
},
|
|
6945
|
-
"required": [
|
|
6946
|
-
"label",
|
|
6947
|
-
"type",
|
|
6948
|
-
"key"
|
|
6949
|
-
],
|
|
6950
|
-
"additionalProperties": true,
|
|
6951
|
-
"shortClassName": "buttonControlBean",
|
|
6952
|
-
"type": "object",
|
|
6953
|
-
"title": "ButtonControl",
|
|
6954
|
-
"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"
|
|
6955
|
-
},
|
|
6956
|
-
"type": "array",
|
|
6957
|
-
"fieldDescription": "\n\nControls which will appear in the control group\n\n"
|
|
6958
|
-
},
|
|
6959
|
-
"type": {
|
|
6960
|
-
"enum": [
|
|
6961
|
-
"group",
|
|
6962
|
-
"GROUP"
|
|
6963
|
-
],
|
|
6964
|
-
"type": "string",
|
|
6965
|
-
"fieldDescription": "\n\nThe type field must be set to 'group'\n\n"
|
|
6966
|
-
}
|
|
6967
|
-
},
|
|
6968
|
-
"required": [
|
|
6969
|
-
"controls",
|
|
6970
|
-
"type"
|
|
6971
|
-
],
|
|
6972
|
-
"shortClassName": "controlGroupBean",
|
|
6973
|
-
"type": "object",
|
|
6974
|
-
"title": "ControlGroup",
|
|
6975
|
-
"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"
|
|
6976
7166
|
}
|
|
6977
7167
|
]
|
|
6978
7168
|
},
|
|
@@ -7175,10 +7365,10 @@
|
|
|
7175
7365
|
"type": "object",
|
|
7176
7366
|
"anyOf": [
|
|
7177
7367
|
{
|
|
7178
|
-
"$ref": "#/definitions/
|
|
7368
|
+
"$ref": "#/definitions/singleCondition"
|
|
7179
7369
|
},
|
|
7180
7370
|
{
|
|
7181
|
-
"$ref": "#/definitions/
|
|
7371
|
+
"$ref": "#/definitions/compositeCondition"
|
|
7182
7372
|
}
|
|
7183
7373
|
]
|
|
7184
7374
|
},
|
|
@@ -7255,22 +7445,6 @@
|
|
|
7255
7445
|
"title": "Inline Dialog Options",
|
|
7256
7446
|
"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"
|
|
7257
7447
|
},
|
|
7258
|
-
{
|
|
7259
|
-
"properties": {
|
|
7260
|
-
"key": {
|
|
7261
|
-
"maxLength": 100,
|
|
7262
|
-
"type": "string",
|
|
7263
|
-
"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"
|
|
7264
|
-
}
|
|
7265
|
-
},
|
|
7266
|
-
"required": [
|
|
7267
|
-
"key"
|
|
7268
|
-
],
|
|
7269
|
-
"shortClassName": "dialogModuleOptions",
|
|
7270
|
-
"type": "object",
|
|
7271
|
-
"title": "Dialog Module Options",
|
|
7272
|
-
"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"
|
|
7273
|
-
},
|
|
7274
7448
|
{
|
|
7275
7449
|
"properties": {
|
|
7276
7450
|
"size": {
|
|
@@ -7315,6 +7489,22 @@
|
|
|
7315
7489
|
"type": "object",
|
|
7316
7490
|
"title": "Dialog Options",
|
|
7317
7491
|
"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"
|
|
7492
|
+
},
|
|
7493
|
+
{
|
|
7494
|
+
"properties": {
|
|
7495
|
+
"key": {
|
|
7496
|
+
"maxLength": 100,
|
|
7497
|
+
"type": "string",
|
|
7498
|
+
"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"
|
|
7499
|
+
}
|
|
7500
|
+
},
|
|
7501
|
+
"required": [
|
|
7502
|
+
"key"
|
|
7503
|
+
],
|
|
7504
|
+
"shortClassName": "dialogModuleOptions",
|
|
7505
|
+
"type": "object",
|
|
7506
|
+
"title": "Dialog Module Options",
|
|
7507
|
+
"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"
|
|
7318
7508
|
}
|
|
7319
7509
|
]
|
|
7320
7510
|
},
|