@forge/manifest 2.5.0-next.4 → 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 +6 -0
- package/out/schema/manifest-schema.json +226 -226
- package/out/schema/manifest.d.ts +218 -218
- package/package.json +1 -1
|
@@ -5482,10 +5482,10 @@
|
|
|
5482
5482
|
"type": "object",
|
|
5483
5483
|
"anyOf": [
|
|
5484
5484
|
{
|
|
5485
|
-
"$ref": "#/definitions/
|
|
5485
|
+
"$ref": "#/definitions/singleCondition"
|
|
5486
5486
|
},
|
|
5487
5487
|
{
|
|
5488
|
-
"$ref": "#/definitions/
|
|
5488
|
+
"$ref": "#/definitions/compositeCondition"
|
|
5489
5489
|
}
|
|
5490
5490
|
]
|
|
5491
5491
|
},
|
|
@@ -5604,10 +5604,10 @@
|
|
|
5604
5604
|
"type": "object",
|
|
5605
5605
|
"anyOf": [
|
|
5606
5606
|
{
|
|
5607
|
-
"$ref": "#/definitions/
|
|
5607
|
+
"$ref": "#/definitions/singleCondition"
|
|
5608
5608
|
},
|
|
5609
5609
|
{
|
|
5610
|
-
"$ref": "#/definitions/
|
|
5610
|
+
"$ref": "#/definitions/compositeCondition"
|
|
5611
5611
|
}
|
|
5612
5612
|
]
|
|
5613
5613
|
},
|
|
@@ -5735,6 +5735,53 @@
|
|
|
5735
5735
|
"type": "object",
|
|
5736
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",
|
|
5737
5737
|
"anyOf": [
|
|
5738
|
+
{
|
|
5739
|
+
"properties": {
|
|
5740
|
+
"offsetX": {
|
|
5741
|
+
"maxLength": 10,
|
|
5742
|
+
"type": "string",
|
|
5743
|
+
"fieldDescription": "\n\nSets an offset distance of the inline-dialog from the trigger element along the x-axis in pixels\n\n"
|
|
5744
|
+
},
|
|
5745
|
+
"offsetY": {
|
|
5746
|
+
"maxLength": 10,
|
|
5747
|
+
"type": "string",
|
|
5748
|
+
"fieldDescription": "\n\nSets an offset distance of the inline-dialog from the trigger element along the y-axis in pixels\n\n"
|
|
5749
|
+
},
|
|
5750
|
+
"width": {
|
|
5751
|
+
"maxLength": 10,
|
|
5752
|
+
"type": "string",
|
|
5753
|
+
"fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
|
|
5754
|
+
},
|
|
5755
|
+
"onTop": {
|
|
5756
|
+
"type": "boolean",
|
|
5757
|
+
"fieldDescription": "\n\nDetermines if the dialog should be shown above the trigger or not. If this option is true but there is insufficient room above the trigger the inline-dialog will be flipped to display below it\n\n"
|
|
5758
|
+
},
|
|
5759
|
+
"showDelay": {
|
|
5760
|
+
"type": "integer",
|
|
5761
|
+
"fieldDescription": "\n\nDetermines how long in milliseconds after a show trigger is fired (such as a trigger click) until the dialog is shown\n\n"
|
|
5762
|
+
},
|
|
5763
|
+
"closeOthers": {
|
|
5764
|
+
"type": "boolean",
|
|
5765
|
+
"fieldDescription": "\n\nDetermines if all other dialogs on the screen are closed when this one is opened\n\n"
|
|
5766
|
+
},
|
|
5767
|
+
"persistent": {
|
|
5768
|
+
"type": "boolean",
|
|
5769
|
+
"fieldDescription": "\n\nThis option, ignores the 'closeOthers' option\n\n"
|
|
5770
|
+
},
|
|
5771
|
+
"onHover": {
|
|
5772
|
+
"type": "boolean",
|
|
5773
|
+
"fieldDescription": "\n\nDetermines whether the inline-Dialog will show on a mouseOver or mouseClick of the trigger\n\n"
|
|
5774
|
+
},
|
|
5775
|
+
"isRelativeToMouse": {
|
|
5776
|
+
"type": "boolean",
|
|
5777
|
+
"fieldDescription": "\n\nDetermines if the dialog should be shown relative to where the mouse is at the time of the event trigger (normally a click) if set to false the dialog will show aligned to the left of the trigger with the arrow showing at the center\n\n"
|
|
5778
|
+
}
|
|
5779
|
+
},
|
|
5780
|
+
"shortClassName": "inlineDialogOptions",
|
|
5781
|
+
"type": "object",
|
|
5782
|
+
"title": "Inline Dialog Options",
|
|
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"
|
|
5784
|
+
},
|
|
5738
5785
|
{
|
|
5739
5786
|
"properties": {
|
|
5740
5787
|
"key": {
|
|
@@ -5795,53 +5842,6 @@
|
|
|
5795
5842
|
"type": "object",
|
|
5796
5843
|
"title": "Dialog Options",
|
|
5797
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"
|
|
5798
|
-
},
|
|
5799
|
-
{
|
|
5800
|
-
"properties": {
|
|
5801
|
-
"offsetX": {
|
|
5802
|
-
"maxLength": 10,
|
|
5803
|
-
"type": "string",
|
|
5804
|
-
"fieldDescription": "\n\nSets an offset distance of the inline-dialog from the trigger element along the x-axis in pixels\n\n"
|
|
5805
|
-
},
|
|
5806
|
-
"offsetY": {
|
|
5807
|
-
"maxLength": 10,
|
|
5808
|
-
"type": "string",
|
|
5809
|
-
"fieldDescription": "\n\nSets an offset distance of the inline-dialog from the trigger element along the y-axis in pixels\n\n"
|
|
5810
|
-
},
|
|
5811
|
-
"width": {
|
|
5812
|
-
"maxLength": 10,
|
|
5813
|
-
"type": "string",
|
|
5814
|
-
"fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
|
|
5815
|
-
},
|
|
5816
|
-
"onTop": {
|
|
5817
|
-
"type": "boolean",
|
|
5818
|
-
"fieldDescription": "\n\nDetermines if the dialog should be shown above the trigger or not. If this option is true but there is insufficient room above the trigger the inline-dialog will be flipped to display below it\n\n"
|
|
5819
|
-
},
|
|
5820
|
-
"showDelay": {
|
|
5821
|
-
"type": "integer",
|
|
5822
|
-
"fieldDescription": "\n\nDetermines how long in milliseconds after a show trigger is fired (such as a trigger click) until the dialog is shown\n\n"
|
|
5823
|
-
},
|
|
5824
|
-
"closeOthers": {
|
|
5825
|
-
"type": "boolean",
|
|
5826
|
-
"fieldDescription": "\n\nDetermines if all other dialogs on the screen are closed when this one is opened\n\n"
|
|
5827
|
-
},
|
|
5828
|
-
"persistent": {
|
|
5829
|
-
"type": "boolean",
|
|
5830
|
-
"fieldDescription": "\n\nThis option, ignores the 'closeOthers' option\n\n"
|
|
5831
|
-
},
|
|
5832
|
-
"onHover": {
|
|
5833
|
-
"type": "boolean",
|
|
5834
|
-
"fieldDescription": "\n\nDetermines whether the inline-Dialog will show on a mouseOver or mouseClick of the trigger\n\n"
|
|
5835
|
-
},
|
|
5836
|
-
"isRelativeToMouse": {
|
|
5837
|
-
"type": "boolean",
|
|
5838
|
-
"fieldDescription": "\n\nDetermines if the dialog should be shown relative to where the mouse is at the time of the event trigger (normally a click) if set to false the dialog will show aligned to the left of the trigger with the arrow showing at the center\n\n"
|
|
5839
|
-
}
|
|
5840
|
-
},
|
|
5841
|
-
"shortClassName": "inlineDialogOptions",
|
|
5842
|
-
"type": "object",
|
|
5843
|
-
"title": "Inline Dialog Options",
|
|
5844
|
-
"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"
|
|
5845
5845
|
}
|
|
5846
5846
|
]
|
|
5847
5847
|
},
|
|
@@ -6161,6 +6161,33 @@
|
|
|
6161
6161
|
"items": {
|
|
6162
6162
|
"type": "object",
|
|
6163
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
|
+
},
|
|
6164
6191
|
{
|
|
6165
6192
|
"properties": {
|
|
6166
6193
|
"conditions": {
|
|
@@ -6193,33 +6220,6 @@
|
|
|
6193
6220
|
"type": "object",
|
|
6194
6221
|
"title": "Composite Condition",
|
|
6195
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"
|
|
6196
|
-
},
|
|
6197
|
-
{
|
|
6198
|
-
"properties": {
|
|
6199
|
-
"condition": {
|
|
6200
|
-
"maxLength": 100,
|
|
6201
|
-
"type": "string",
|
|
6202
|
-
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
6203
|
-
},
|
|
6204
|
-
"invert": {
|
|
6205
|
-
"type": "boolean",
|
|
6206
|
-
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
6207
|
-
"defaultValue": "false"
|
|
6208
|
-
},
|
|
6209
|
-
"params": {
|
|
6210
|
-
"additionalProperties": true,
|
|
6211
|
-
"type": "object",
|
|
6212
|
-
"fieldTitle": "Object",
|
|
6213
|
-
"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"
|
|
6214
|
-
}
|
|
6215
|
-
},
|
|
6216
|
-
"required": [
|
|
6217
|
-
"condition"
|
|
6218
|
-
],
|
|
6219
|
-
"shortClassName": "singleConditionBean",
|
|
6220
|
-
"type": "object",
|
|
6221
|
-
"title": "Single Condition",
|
|
6222
|
-
"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"
|
|
6223
6223
|
}
|
|
6224
6224
|
]
|
|
6225
6225
|
},
|
|
@@ -6493,6 +6493,38 @@
|
|
|
6493
6493
|
"items": {
|
|
6494
6494
|
"type": "object",
|
|
6495
6495
|
"anyOf": [
|
|
6496
|
+
{
|
|
6497
|
+
"properties": {
|
|
6498
|
+
"label": {
|
|
6499
|
+
"$ref": "#/definitions/i18nProperty",
|
|
6500
|
+
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
6501
|
+
},
|
|
6502
|
+
"type": {
|
|
6503
|
+
"enum": [
|
|
6504
|
+
"button",
|
|
6505
|
+
"BUTTON"
|
|
6506
|
+
],
|
|
6507
|
+
"type": "string",
|
|
6508
|
+
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
6509
|
+
},
|
|
6510
|
+
"key": {
|
|
6511
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
6512
|
+
"maxLength": 100,
|
|
6513
|
+
"type": "string",
|
|
6514
|
+
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
6515
|
+
}
|
|
6516
|
+
},
|
|
6517
|
+
"required": [
|
|
6518
|
+
"label",
|
|
6519
|
+
"type",
|
|
6520
|
+
"key"
|
|
6521
|
+
],
|
|
6522
|
+
"additionalProperties": true,
|
|
6523
|
+
"shortClassName": "buttonControlBean",
|
|
6524
|
+
"type": "object",
|
|
6525
|
+
"title": "ButtonControl",
|
|
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"
|
|
6527
|
+
},
|
|
6496
6528
|
{
|
|
6497
6529
|
"properties": {
|
|
6498
6530
|
"controls": {
|
|
@@ -6549,70 +6581,6 @@
|
|
|
6549
6581
|
"title": "ControlGroup",
|
|
6550
6582
|
"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"
|
|
6551
6583
|
},
|
|
6552
|
-
{
|
|
6553
|
-
"properties": {
|
|
6554
|
-
"label": {
|
|
6555
|
-
"$ref": "#/definitions/i18nProperty",
|
|
6556
|
-
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
6557
|
-
},
|
|
6558
|
-
"type": {
|
|
6559
|
-
"enum": [
|
|
6560
|
-
"button",
|
|
6561
|
-
"BUTTON"
|
|
6562
|
-
],
|
|
6563
|
-
"type": "string",
|
|
6564
|
-
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
6565
|
-
},
|
|
6566
|
-
"key": {
|
|
6567
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
6568
|
-
"maxLength": 100,
|
|
6569
|
-
"type": "string",
|
|
6570
|
-
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
6571
|
-
}
|
|
6572
|
-
},
|
|
6573
|
-
"required": [
|
|
6574
|
-
"label",
|
|
6575
|
-
"type",
|
|
6576
|
-
"key"
|
|
6577
|
-
],
|
|
6578
|
-
"additionalProperties": true,
|
|
6579
|
-
"shortClassName": "buttonControlBean",
|
|
6580
|
-
"type": "object",
|
|
6581
|
-
"title": "ButtonControl",
|
|
6582
|
-
"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"
|
|
6583
|
-
},
|
|
6584
|
-
{
|
|
6585
|
-
"properties": {
|
|
6586
|
-
"macroParameter": {
|
|
6587
|
-
"maxLength": 100,
|
|
6588
|
-
"type": "string",
|
|
6589
|
-
"fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
|
|
6590
|
-
},
|
|
6591
|
-
"type": {
|
|
6592
|
-
"enum": [
|
|
6593
|
-
"text",
|
|
6594
|
-
"TEXT"
|
|
6595
|
-
],
|
|
6596
|
-
"type": "string",
|
|
6597
|
-
"fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
|
|
6598
|
-
},
|
|
6599
|
-
"key": {
|
|
6600
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
6601
|
-
"maxLength": 100,
|
|
6602
|
-
"type": "string",
|
|
6603
|
-
"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"
|
|
6604
|
-
}
|
|
6605
|
-
},
|
|
6606
|
-
"required": [
|
|
6607
|
-
"macroParameter",
|
|
6608
|
-
"type",
|
|
6609
|
-
"key"
|
|
6610
|
-
],
|
|
6611
|
-
"shortClassName": "textControlBean",
|
|
6612
|
-
"type": "object",
|
|
6613
|
-
"title": "TextControl",
|
|
6614
|
-
"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"
|
|
6615
|
-
},
|
|
6616
6584
|
{
|
|
6617
6585
|
"properties": {
|
|
6618
6586
|
"controls": {
|
|
@@ -6681,6 +6649,38 @@
|
|
|
6681
6649
|
"type": "object",
|
|
6682
6650
|
"title": "ToggleGroup",
|
|
6683
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"
|
|
6684
6684
|
}
|
|
6685
6685
|
]
|
|
6686
6686
|
},
|
|
@@ -7012,22 +7012,17 @@
|
|
|
7012
7012
|
"controls": {
|
|
7013
7013
|
"items": {
|
|
7014
7014
|
"properties": {
|
|
7015
|
-
"macroParameterValue": {
|
|
7016
|
-
"maxLength": 10000,
|
|
7017
|
-
"type": "string",
|
|
7018
|
-
"fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n"
|
|
7019
|
-
},
|
|
7020
7015
|
"label": {
|
|
7021
7016
|
"$ref": "#/definitions/i18nProperty",
|
|
7022
7017
|
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
7023
7018
|
},
|
|
7024
7019
|
"type": {
|
|
7025
7020
|
"enum": [
|
|
7026
|
-
"
|
|
7027
|
-
"
|
|
7021
|
+
"button",
|
|
7022
|
+
"BUTTON"
|
|
7028
7023
|
],
|
|
7029
7024
|
"type": "string",
|
|
7030
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
7025
|
+
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
7031
7026
|
},
|
|
7032
7027
|
"key": {
|
|
7033
7028
|
"pattern": "^[a-zA-Z0-9-]+$",
|
|
@@ -7037,44 +7032,36 @@
|
|
|
7037
7032
|
}
|
|
7038
7033
|
},
|
|
7039
7034
|
"required": [
|
|
7040
|
-
"macroParameterValue",
|
|
7041
7035
|
"label",
|
|
7042
7036
|
"type",
|
|
7043
7037
|
"key"
|
|
7044
7038
|
],
|
|
7045
7039
|
"additionalProperties": true,
|
|
7046
|
-
"shortClassName": "
|
|
7040
|
+
"shortClassName": "buttonControlBean",
|
|
7047
7041
|
"type": "object",
|
|
7048
|
-
"title": "
|
|
7049
|
-
"description": "\n\nDefines a
|
|
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"
|
|
7050
7044
|
},
|
|
7051
7045
|
"type": "array",
|
|
7052
|
-
"fieldDescription": "\n\
|
|
7053
|
-
},
|
|
7054
|
-
"macroParameter": {
|
|
7055
|
-
"pattern": "[-_a-z0-9\\.]+",
|
|
7056
|
-
"maxLength": 100,
|
|
7057
|
-
"type": "string",
|
|
7058
|
-
"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"
|
|
7046
|
+
"fieldDescription": "\n\nControls which will appear in the control group\n\n"
|
|
7059
7047
|
},
|
|
7060
7048
|
"type": {
|
|
7061
7049
|
"enum": [
|
|
7062
|
-
"
|
|
7063
|
-
"
|
|
7050
|
+
"group",
|
|
7051
|
+
"GROUP"
|
|
7064
7052
|
],
|
|
7065
7053
|
"type": "string",
|
|
7066
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
7054
|
+
"fieldDescription": "\n\nThe type field must be set to 'group'\n\n"
|
|
7067
7055
|
}
|
|
7068
7056
|
},
|
|
7069
7057
|
"required": [
|
|
7070
7058
|
"controls",
|
|
7071
|
-
"macroParameter",
|
|
7072
7059
|
"type"
|
|
7073
7060
|
],
|
|
7074
|
-
"shortClassName": "
|
|
7061
|
+
"shortClassName": "controlGroupBean",
|
|
7075
7062
|
"type": "object",
|
|
7076
|
-
"title": "
|
|
7077
|
-
"description": "\n\nDefines a
|
|
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"
|
|
7078
7065
|
},
|
|
7079
7066
|
{
|
|
7080
7067
|
"properties": {
|
|
@@ -7113,17 +7100,22 @@
|
|
|
7113
7100
|
"controls": {
|
|
7114
7101
|
"items": {
|
|
7115
7102
|
"properties": {
|
|
7103
|
+
"macroParameterValue": {
|
|
7104
|
+
"maxLength": 10000,
|
|
7105
|
+
"type": "string",
|
|
7106
|
+
"fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n"
|
|
7107
|
+
},
|
|
7116
7108
|
"label": {
|
|
7117
7109
|
"$ref": "#/definitions/i18nProperty",
|
|
7118
7110
|
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
7119
7111
|
},
|
|
7120
7112
|
"type": {
|
|
7121
7113
|
"enum": [
|
|
7122
|
-
"
|
|
7123
|
-
"
|
|
7114
|
+
"togglebutton",
|
|
7115
|
+
"TOGGLEBUTTON"
|
|
7124
7116
|
],
|
|
7125
7117
|
"type": "string",
|
|
7126
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
7118
|
+
"fieldDescription": "\n\nThe type field must be set to 'togglebutton'\n\n"
|
|
7127
7119
|
},
|
|
7128
7120
|
"key": {
|
|
7129
7121
|
"pattern": "^[a-zA-Z0-9-]+$",
|
|
@@ -7133,36 +7125,44 @@
|
|
|
7133
7125
|
}
|
|
7134
7126
|
},
|
|
7135
7127
|
"required": [
|
|
7128
|
+
"macroParameterValue",
|
|
7136
7129
|
"label",
|
|
7137
7130
|
"type",
|
|
7138
7131
|
"key"
|
|
7139
7132
|
],
|
|
7140
7133
|
"additionalProperties": true,
|
|
7141
|
-
"shortClassName": "
|
|
7134
|
+
"shortClassName": "macroToggleButtonControlBean",
|
|
7142
7135
|
"type": "object",
|
|
7143
|
-
"title": "
|
|
7144
|
-
"description": "\n\nDefines a button which
|
|
7136
|
+
"title": "ToggleButtonControl",
|
|
7137
|
+
"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"
|
|
7145
7138
|
},
|
|
7146
7139
|
"type": "array",
|
|
7147
|
-
"fieldDescription": "\n\
|
|
7140
|
+
"fieldDescription": "\n\nToggle buttons which will appear in the toggle group\n\n"
|
|
7141
|
+
},
|
|
7142
|
+
"macroParameter": {
|
|
7143
|
+
"pattern": "[-_a-z0-9\\.]+",
|
|
7144
|
+
"maxLength": 100,
|
|
7145
|
+
"type": "string",
|
|
7146
|
+
"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"
|
|
7148
7147
|
},
|
|
7149
7148
|
"type": {
|
|
7150
7149
|
"enum": [
|
|
7151
|
-
"
|
|
7152
|
-
"
|
|
7150
|
+
"togglegroup",
|
|
7151
|
+
"TOGGLEGROUP"
|
|
7153
7152
|
],
|
|
7154
7153
|
"type": "string",
|
|
7155
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
7154
|
+
"fieldDescription": "\n\nThe type field must be set to 'togglegroup'\n\n"
|
|
7156
7155
|
}
|
|
7157
7156
|
},
|
|
7158
7157
|
"required": [
|
|
7159
7158
|
"controls",
|
|
7159
|
+
"macroParameter",
|
|
7160
7160
|
"type"
|
|
7161
7161
|
],
|
|
7162
|
-
"shortClassName": "
|
|
7162
|
+
"shortClassName": "macroToggleGroupBean",
|
|
7163
7163
|
"type": "object",
|
|
7164
|
-
"title": "
|
|
7165
|
-
"description": "\n\nDefines a
|
|
7164
|
+
"title": "ToggleGroup",
|
|
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"
|
|
7166
7166
|
}
|
|
7167
7167
|
]
|
|
7168
7168
|
},
|
|
@@ -7398,51 +7398,6 @@
|
|
|
7398
7398
|
"type": "object",
|
|
7399
7399
|
"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",
|
|
7400
7400
|
"anyOf": [
|
|
7401
|
-
{
|
|
7402
|
-
"properties": {
|
|
7403
|
-
"size": {
|
|
7404
|
-
"enum": [
|
|
7405
|
-
"small",
|
|
7406
|
-
"SMALL",
|
|
7407
|
-
"medium",
|
|
7408
|
-
"MEDIUM",
|
|
7409
|
-
"large",
|
|
7410
|
-
"LARGE",
|
|
7411
|
-
"x-large",
|
|
7412
|
-
"X-LARGE",
|
|
7413
|
-
"fullscreen",
|
|
7414
|
-
"FULLSCREEN",
|
|
7415
|
-
"maximum",
|
|
7416
|
-
"MAXIMUM"
|
|
7417
|
-
],
|
|
7418
|
-
"type": "string",
|
|
7419
|
-
"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"
|
|
7420
|
-
},
|
|
7421
|
-
"chrome": {
|
|
7422
|
-
"type": "boolean",
|
|
7423
|
-
"fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
|
|
7424
|
-
"defaultValue": "true"
|
|
7425
|
-
},
|
|
7426
|
-
"width": {
|
|
7427
|
-
"maxLength": 10,
|
|
7428
|
-
"type": "string",
|
|
7429
|
-
"fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
|
|
7430
|
-
},
|
|
7431
|
-
"header": {
|
|
7432
|
-
"$ref": "#/definitions/i18nProperty",
|
|
7433
|
-
"fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
|
|
7434
|
-
},
|
|
7435
|
-
"height": {
|
|
7436
|
-
"maxLength": 10,
|
|
7437
|
-
"type": "string",
|
|
7438
|
-
"fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
|
|
7439
|
-
}
|
|
7440
|
-
},
|
|
7441
|
-
"shortClassName": "dialogOptions",
|
|
7442
|
-
"type": "object",
|
|
7443
|
-
"title": "Dialog Options",
|
|
7444
|
-
"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"
|
|
7445
|
-
},
|
|
7446
7401
|
{
|
|
7447
7402
|
"properties": {
|
|
7448
7403
|
"offsetX": {
|
|
@@ -7490,6 +7445,51 @@
|
|
|
7490
7445
|
"title": "Inline Dialog Options",
|
|
7491
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"
|
|
7492
7447
|
},
|
|
7448
|
+
{
|
|
7449
|
+
"properties": {
|
|
7450
|
+
"size": {
|
|
7451
|
+
"enum": [
|
|
7452
|
+
"small",
|
|
7453
|
+
"SMALL",
|
|
7454
|
+
"medium",
|
|
7455
|
+
"MEDIUM",
|
|
7456
|
+
"large",
|
|
7457
|
+
"LARGE",
|
|
7458
|
+
"x-large",
|
|
7459
|
+
"X-LARGE",
|
|
7460
|
+
"fullscreen",
|
|
7461
|
+
"FULLSCREEN",
|
|
7462
|
+
"maximum",
|
|
7463
|
+
"MAXIMUM"
|
|
7464
|
+
],
|
|
7465
|
+
"type": "string",
|
|
7466
|
+
"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"
|
|
7467
|
+
},
|
|
7468
|
+
"chrome": {
|
|
7469
|
+
"type": "boolean",
|
|
7470
|
+
"fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
|
|
7471
|
+
"defaultValue": "true"
|
|
7472
|
+
},
|
|
7473
|
+
"width": {
|
|
7474
|
+
"maxLength": 10,
|
|
7475
|
+
"type": "string",
|
|
7476
|
+
"fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
|
|
7477
|
+
},
|
|
7478
|
+
"header": {
|
|
7479
|
+
"$ref": "#/definitions/i18nProperty",
|
|
7480
|
+
"fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
|
|
7481
|
+
},
|
|
7482
|
+
"height": {
|
|
7483
|
+
"maxLength": 10,
|
|
7484
|
+
"type": "string",
|
|
7485
|
+
"fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
|
|
7486
|
+
}
|
|
7487
|
+
},
|
|
7488
|
+
"shortClassName": "dialogOptions",
|
|
7489
|
+
"type": "object",
|
|
7490
|
+
"title": "Dialog Options",
|
|
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
7493
|
{
|
|
7494
7494
|
"properties": {
|
|
7495
7495
|
"key": {
|