@forge/manifest 2.6.0-next.5 → 2.6.0-next.6
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 +10 -0
- package/out/processor/full-validation-processor.d.ts.map +1 -1
- package/out/processor/full-validation-processor.js +2 -0
- package/out/schema/manifest-schema.json +361 -361
- package/out/schema/manifest.d.ts +264 -264
- package/out/scopes/deprecated-shipyard-scopes.json +24 -0
- package/out/scopes/shipyard-scopes.json +47 -71
- package/out/text/errors.d.ts +1 -0
- package/out/text/errors.d.ts.map +1 -1
- package/out/text/errors.js +2 -1
- package/out/validators/deprecated-permissions-validator.d.ts +7 -0
- package/out/validators/deprecated-permissions-validator.d.ts.map +1 -0
- package/out/validators/deprecated-permissions-validator.js +31 -0
- package/out/validators/permissions-validator.d.ts.map +1 -1
- package/out/validators/permissions-validator.js +3 -1
- package/package.json +1 -1
|
@@ -5417,10 +5417,10 @@
|
|
|
5417
5417
|
"type": "object",
|
|
5418
5418
|
"anyOf": [
|
|
5419
5419
|
{
|
|
5420
|
-
"$ref": "#/definitions/
|
|
5420
|
+
"$ref": "#/definitions/singleCondition"
|
|
5421
5421
|
},
|
|
5422
5422
|
{
|
|
5423
|
-
"$ref": "#/definitions/
|
|
5423
|
+
"$ref": "#/definitions/compositeCondition"
|
|
5424
5424
|
}
|
|
5425
5425
|
]
|
|
5426
5426
|
},
|
|
@@ -5543,10 +5543,10 @@
|
|
|
5543
5543
|
"type": "object",
|
|
5544
5544
|
"anyOf": [
|
|
5545
5545
|
{
|
|
5546
|
-
"$ref": "#/definitions/
|
|
5546
|
+
"$ref": "#/definitions/compositeCondition"
|
|
5547
5547
|
},
|
|
5548
5548
|
{
|
|
5549
|
-
"$ref": "#/definitions/
|
|
5549
|
+
"$ref": "#/definitions/singleCondition"
|
|
5550
5550
|
}
|
|
5551
5551
|
]
|
|
5552
5552
|
},
|
|
@@ -5665,10 +5665,10 @@
|
|
|
5665
5665
|
"type": "object",
|
|
5666
5666
|
"anyOf": [
|
|
5667
5667
|
{
|
|
5668
|
-
"$ref": "#/definitions/
|
|
5668
|
+
"$ref": "#/definitions/singleCondition"
|
|
5669
5669
|
},
|
|
5670
5670
|
{
|
|
5671
|
-
"$ref": "#/definitions/
|
|
5671
|
+
"$ref": "#/definitions/compositeCondition"
|
|
5672
5672
|
}
|
|
5673
5673
|
]
|
|
5674
5674
|
},
|
|
@@ -5798,19 +5798,50 @@
|
|
|
5798
5798
|
"anyOf": [
|
|
5799
5799
|
{
|
|
5800
5800
|
"properties": {
|
|
5801
|
-
"
|
|
5802
|
-
"maxLength":
|
|
5801
|
+
"offsetX": {
|
|
5802
|
+
"maxLength": 10,
|
|
5803
5803
|
"type": "string",
|
|
5804
|
-
"fieldDescription": "\n\
|
|
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"
|
|
5805
5839
|
}
|
|
5806
5840
|
},
|
|
5807
|
-
"
|
|
5808
|
-
"key"
|
|
5809
|
-
],
|
|
5810
|
-
"shortClassName": "dialogModuleOptions",
|
|
5841
|
+
"shortClassName": "inlineDialogOptions",
|
|
5811
5842
|
"type": "object",
|
|
5812
|
-
"title": "Dialog
|
|
5813
|
-
"description": "\n\nOptions for
|
|
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"
|
|
5814
5845
|
},
|
|
5815
5846
|
{
|
|
5816
5847
|
"properties": {
|
|
@@ -5859,50 +5890,19 @@
|
|
|
5859
5890
|
},
|
|
5860
5891
|
{
|
|
5861
5892
|
"properties": {
|
|
5862
|
-
"
|
|
5863
|
-
"maxLength":
|
|
5864
|
-
"type": "string",
|
|
5865
|
-
"fieldDescription": "\n\nSets an offset distance of the inline-dialog from the trigger element along the x-axis in pixels\n\n"
|
|
5866
|
-
},
|
|
5867
|
-
"offsetY": {
|
|
5868
|
-
"maxLength": 10,
|
|
5869
|
-
"type": "string",
|
|
5870
|
-
"fieldDescription": "\n\nSets an offset distance of the inline-dialog from the trigger element along the y-axis in pixels\n\n"
|
|
5871
|
-
},
|
|
5872
|
-
"width": {
|
|
5873
|
-
"maxLength": 10,
|
|
5893
|
+
"key": {
|
|
5894
|
+
"maxLength": 100,
|
|
5874
5895
|
"type": "string",
|
|
5875
|
-
"fieldDescription": "\n\
|
|
5876
|
-
},
|
|
5877
|
-
"onTop": {
|
|
5878
|
-
"type": "boolean",
|
|
5879
|
-
"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"
|
|
5880
|
-
},
|
|
5881
|
-
"showDelay": {
|
|
5882
|
-
"type": "integer",
|
|
5883
|
-
"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"
|
|
5884
|
-
},
|
|
5885
|
-
"closeOthers": {
|
|
5886
|
-
"type": "boolean",
|
|
5887
|
-
"fieldDescription": "\n\nDetermines if all other dialogs on the screen are closed when this one is opened\n\n"
|
|
5888
|
-
},
|
|
5889
|
-
"persistent": {
|
|
5890
|
-
"type": "boolean",
|
|
5891
|
-
"fieldDescription": "\n\nThis option, ignores the 'closeOthers' option\n\n"
|
|
5892
|
-
},
|
|
5893
|
-
"onHover": {
|
|
5894
|
-
"type": "boolean",
|
|
5895
|
-
"fieldDescription": "\n\nDetermines whether the inline-Dialog will show on a mouseOver or mouseClick of the trigger\n\n"
|
|
5896
|
-
},
|
|
5897
|
-
"isRelativeToMouse": {
|
|
5898
|
-
"type": "boolean",
|
|
5899
|
-
"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"
|
|
5896
|
+
"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"
|
|
5900
5897
|
}
|
|
5901
5898
|
},
|
|
5902
|
-
"
|
|
5899
|
+
"required": [
|
|
5900
|
+
"key"
|
|
5901
|
+
],
|
|
5902
|
+
"shortClassName": "dialogModuleOptions",
|
|
5903
5903
|
"type": "object",
|
|
5904
|
-
"title": "
|
|
5905
|
-
"description": "\n\nOptions for
|
|
5904
|
+
"title": "Dialog Module Options",
|
|
5905
|
+
"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"
|
|
5906
5906
|
}
|
|
5907
5907
|
]
|
|
5908
5908
|
},
|
|
@@ -5993,10 +5993,10 @@
|
|
|
5993
5993
|
"type": "object",
|
|
5994
5994
|
"anyOf": [
|
|
5995
5995
|
{
|
|
5996
|
-
"$ref": "
|
|
5996
|
+
"$ref": "#"
|
|
5997
5997
|
},
|
|
5998
5998
|
{
|
|
5999
|
-
"$ref": "
|
|
5999
|
+
"$ref": "#/definitions/singleCondition"
|
|
6000
6000
|
}
|
|
6001
6001
|
]
|
|
6002
6002
|
},
|
|
@@ -6071,10 +6071,10 @@
|
|
|
6071
6071
|
"type": "object",
|
|
6072
6072
|
"anyOf": [
|
|
6073
6073
|
{
|
|
6074
|
-
"$ref": "#/definitions/
|
|
6074
|
+
"$ref": "#/definitions/singleCondition"
|
|
6075
6075
|
},
|
|
6076
6076
|
{
|
|
6077
|
-
"$ref": "#/definitions/
|
|
6077
|
+
"$ref": "#/definitions/compositeCondition"
|
|
6078
6078
|
}
|
|
6079
6079
|
]
|
|
6080
6080
|
},
|
|
@@ -6222,33 +6222,6 @@
|
|
|
6222
6222
|
"items": {
|
|
6223
6223
|
"type": "object",
|
|
6224
6224
|
"anyOf": [
|
|
6225
|
-
{
|
|
6226
|
-
"properties": {
|
|
6227
|
-
"condition": {
|
|
6228
|
-
"maxLength": 100,
|
|
6229
|
-
"type": "string",
|
|
6230
|
-
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
6231
|
-
},
|
|
6232
|
-
"invert": {
|
|
6233
|
-
"type": "boolean",
|
|
6234
|
-
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
6235
|
-
"defaultValue": "false"
|
|
6236
|
-
},
|
|
6237
|
-
"params": {
|
|
6238
|
-
"additionalProperties": true,
|
|
6239
|
-
"type": "object",
|
|
6240
|
-
"fieldTitle": "Object",
|
|
6241
|
-
"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"
|
|
6242
|
-
}
|
|
6243
|
-
},
|
|
6244
|
-
"required": [
|
|
6245
|
-
"condition"
|
|
6246
|
-
],
|
|
6247
|
-
"shortClassName": "singleConditionBean",
|
|
6248
|
-
"type": "object",
|
|
6249
|
-
"title": "Single Condition",
|
|
6250
|
-
"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"
|
|
6251
|
-
},
|
|
6252
6225
|
{
|
|
6253
6226
|
"properties": {
|
|
6254
6227
|
"conditions": {
|
|
@@ -6256,10 +6229,10 @@
|
|
|
6256
6229
|
"type": "object",
|
|
6257
6230
|
"anyOf": [
|
|
6258
6231
|
{
|
|
6259
|
-
"$ref": "
|
|
6232
|
+
"$ref": "#"
|
|
6260
6233
|
},
|
|
6261
6234
|
{
|
|
6262
|
-
"$ref": "
|
|
6235
|
+
"$ref": "#/definitions/singleCondition"
|
|
6263
6236
|
}
|
|
6264
6237
|
]
|
|
6265
6238
|
},
|
|
@@ -6281,6 +6254,33 @@
|
|
|
6281
6254
|
"type": "object",
|
|
6282
6255
|
"title": "Composite Condition",
|
|
6283
6256
|
"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"
|
|
6257
|
+
},
|
|
6258
|
+
{
|
|
6259
|
+
"properties": {
|
|
6260
|
+
"condition": {
|
|
6261
|
+
"maxLength": 100,
|
|
6262
|
+
"type": "string",
|
|
6263
|
+
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
6264
|
+
},
|
|
6265
|
+
"invert": {
|
|
6266
|
+
"type": "boolean",
|
|
6267
|
+
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
6268
|
+
"defaultValue": "false"
|
|
6269
|
+
},
|
|
6270
|
+
"params": {
|
|
6271
|
+
"additionalProperties": true,
|
|
6272
|
+
"type": "object",
|
|
6273
|
+
"fieldTitle": "Object",
|
|
6274
|
+
"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"
|
|
6275
|
+
}
|
|
6276
|
+
},
|
|
6277
|
+
"required": [
|
|
6278
|
+
"condition"
|
|
6279
|
+
],
|
|
6280
|
+
"shortClassName": "singleConditionBean",
|
|
6281
|
+
"type": "object",
|
|
6282
|
+
"title": "Single Condition",
|
|
6283
|
+
"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"
|
|
6284
6284
|
}
|
|
6285
6285
|
]
|
|
6286
6286
|
},
|
|
@@ -6554,6 +6554,38 @@
|
|
|
6554
6554
|
"items": {
|
|
6555
6555
|
"type": "object",
|
|
6556
6556
|
"anyOf": [
|
|
6557
|
+
{
|
|
6558
|
+
"properties": {
|
|
6559
|
+
"macroParameter": {
|
|
6560
|
+
"maxLength": 100,
|
|
6561
|
+
"type": "string",
|
|
6562
|
+
"fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
|
|
6563
|
+
},
|
|
6564
|
+
"type": {
|
|
6565
|
+
"enum": [
|
|
6566
|
+
"text",
|
|
6567
|
+
"TEXT"
|
|
6568
|
+
],
|
|
6569
|
+
"type": "string",
|
|
6570
|
+
"fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
|
|
6571
|
+
},
|
|
6572
|
+
"key": {
|
|
6573
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
6574
|
+
"maxLength": 100,
|
|
6575
|
+
"type": "string",
|
|
6576
|
+
"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"
|
|
6577
|
+
}
|
|
6578
|
+
},
|
|
6579
|
+
"required": [
|
|
6580
|
+
"macroParameter",
|
|
6581
|
+
"type",
|
|
6582
|
+
"key"
|
|
6583
|
+
],
|
|
6584
|
+
"shortClassName": "textControlBean",
|
|
6585
|
+
"type": "object",
|
|
6586
|
+
"title": "TextControl",
|
|
6587
|
+
"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"
|
|
6588
|
+
},
|
|
6557
6589
|
{
|
|
6558
6590
|
"properties": {
|
|
6559
6591
|
"controls": {
|
|
@@ -6610,6 +6642,38 @@
|
|
|
6610
6642
|
"title": "ControlGroup",
|
|
6611
6643
|
"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"
|
|
6612
6644
|
},
|
|
6645
|
+
{
|
|
6646
|
+
"properties": {
|
|
6647
|
+
"label": {
|
|
6648
|
+
"$ref": "#/definitions/i18nProperty",
|
|
6649
|
+
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
6650
|
+
},
|
|
6651
|
+
"type": {
|
|
6652
|
+
"enum": [
|
|
6653
|
+
"button",
|
|
6654
|
+
"BUTTON"
|
|
6655
|
+
],
|
|
6656
|
+
"type": "string",
|
|
6657
|
+
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
6658
|
+
},
|
|
6659
|
+
"key": {
|
|
6660
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
6661
|
+
"maxLength": 100,
|
|
6662
|
+
"type": "string",
|
|
6663
|
+
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
6664
|
+
}
|
|
6665
|
+
},
|
|
6666
|
+
"required": [
|
|
6667
|
+
"label",
|
|
6668
|
+
"type",
|
|
6669
|
+
"key"
|
|
6670
|
+
],
|
|
6671
|
+
"additionalProperties": true,
|
|
6672
|
+
"shortClassName": "buttonControlBean",
|
|
6673
|
+
"type": "object",
|
|
6674
|
+
"title": "ButtonControl",
|
|
6675
|
+
"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"
|
|
6676
|
+
},
|
|
6613
6677
|
{
|
|
6614
6678
|
"properties": {
|
|
6615
6679
|
"controls": {
|
|
@@ -6678,70 +6742,6 @@
|
|
|
6678
6742
|
"type": "object",
|
|
6679
6743
|
"title": "ToggleGroup",
|
|
6680
6744
|
"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"
|
|
6681
|
-
},
|
|
6682
|
-
{
|
|
6683
|
-
"properties": {
|
|
6684
|
-
"macroParameter": {
|
|
6685
|
-
"maxLength": 100,
|
|
6686
|
-
"type": "string",
|
|
6687
|
-
"fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
|
|
6688
|
-
},
|
|
6689
|
-
"type": {
|
|
6690
|
-
"enum": [
|
|
6691
|
-
"text",
|
|
6692
|
-
"TEXT"
|
|
6693
|
-
],
|
|
6694
|
-
"type": "string",
|
|
6695
|
-
"fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
|
|
6696
|
-
},
|
|
6697
|
-
"key": {
|
|
6698
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
6699
|
-
"maxLength": 100,
|
|
6700
|
-
"type": "string",
|
|
6701
|
-
"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"
|
|
6702
|
-
}
|
|
6703
|
-
},
|
|
6704
|
-
"required": [
|
|
6705
|
-
"macroParameter",
|
|
6706
|
-
"type",
|
|
6707
|
-
"key"
|
|
6708
|
-
],
|
|
6709
|
-
"shortClassName": "textControlBean",
|
|
6710
|
-
"type": "object",
|
|
6711
|
-
"title": "TextControl",
|
|
6712
|
-
"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"
|
|
6713
|
-
},
|
|
6714
|
-
{
|
|
6715
|
-
"properties": {
|
|
6716
|
-
"label": {
|
|
6717
|
-
"$ref": "#/definitions/i18nProperty",
|
|
6718
|
-
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
6719
|
-
},
|
|
6720
|
-
"type": {
|
|
6721
|
-
"enum": [
|
|
6722
|
-
"button",
|
|
6723
|
-
"BUTTON"
|
|
6724
|
-
],
|
|
6725
|
-
"type": "string",
|
|
6726
|
-
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
6727
|
-
},
|
|
6728
|
-
"key": {
|
|
6729
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
6730
|
-
"maxLength": 100,
|
|
6731
|
-
"type": "string",
|
|
6732
|
-
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
6733
|
-
}
|
|
6734
|
-
},
|
|
6735
|
-
"required": [
|
|
6736
|
-
"label",
|
|
6737
|
-
"type",
|
|
6738
|
-
"key"
|
|
6739
|
-
],
|
|
6740
|
-
"additionalProperties": true,
|
|
6741
|
-
"shortClassName": "buttonControlBean",
|
|
6742
|
-
"type": "object",
|
|
6743
|
-
"title": "ButtonControl",
|
|
6744
|
-
"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"
|
|
6745
6745
|
}
|
|
6746
6746
|
]
|
|
6747
6747
|
},
|
|
@@ -6962,168 +6962,80 @@
|
|
|
6962
6962
|
"cacheable": {
|
|
6963
6963
|
"type": "boolean",
|
|
6964
6964
|
"fieldDescription": "\n\nReturns whether the URL should be cacheable. Cacheable URLs are taken directly from the add-on descriptor, and\n lack all additional query parameters:\n <ul>\n <li>standard iframe query parameters</li>\n <li>product context parameters</li>\n <li>JWT token</li>\n </ul>\n\n",
|
|
6965
|
-
"defaultValue": "false"
|
|
6966
|
-
},
|
|
6967
|
-
"url": {
|
|
6968
|
-
"format": "uri",
|
|
6969
|
-
"type": "string",
|
|
6970
|
-
"fieldDescription": "\n\nThe URL to the macro configuration page in the add-on.\n\n"
|
|
6971
|
-
},
|
|
6972
|
-
"height": {
|
|
6973
|
-
"maxLength": 10,
|
|
6974
|
-
"type": "string",
|
|
6975
|
-
"fieldDescription": "\n\nThe preferred height of the edit dialog, e.g. ``300px``.\n\n"
|
|
6976
|
-
}
|
|
6977
|
-
},
|
|
6978
|
-
"required": [
|
|
6979
|
-
"url"
|
|
6980
|
-
],
|
|
6981
|
-
"shortClassName": "macroEditorBean",
|
|
6982
|
-
"type": "object",
|
|
6983
|
-
"title": "Macro Editor",
|
|
6984
|
-
"description": "\n\nMacro Parameters go a long way when it comes to macro configuration, but there are cases\n when a macro add-on needs more control over the UI.\n\n Defining a Macro Editor allows you to implement a custom UI for the macro, by specifying a\n URL to a page in your add-on which will be shown in the dialog iFrame.\n\n In order to persist custom data in your macro editor, use the Javascript\n [Confluence API](../../jsapi/confluence/) and the [Dialog API](../../jsapi/dialog/).\n For example:\n\n\n AP.require([\"confluence\", \"dialog\"], function (confluence, dialog) {\n function onSubmit() {\n var macroParams = {\n myParameter: value\n };\n confluence.saveMacro(macroParams);\n confluence.closeMacroEditor();\n return true;\n }\n\n dialog.getButton(\"submit\").bind(onSubmit);\n });\n\n In order to retrieve the custom data again when the editor is opened, use `confluence.getMacroData` (see\n [Confluence API](../../jsapi/confluence/)):\n\n AP.require(\"confluence\", function (confluence) {\n var macroData = confluence.getMacroData(function(macroParams) {\n doSomethingWith(macroParams.myParameter);\n });\n });\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"editor\": {\n \"url\": \"/map-editor\",\n \"editTitle\": {\n \"value\": \"Edit Map\"\n },\n \"insertTitle\": {\n \"value\": \"Insert Map\"\n }\n }\n }\n\n\n",
|
|
6985
|
-
"fieldDescription": "\n\nThe configuration of a custom macro editor. This is useful if the parameter input field types are\n not sufficient to configure the macro.\n\n"
|
|
6986
|
-
},
|
|
6987
|
-
"featured": {
|
|
6988
|
-
"type": "boolean",
|
|
6989
|
-
"fieldDescription": "\n\nWhether the macro should be \"featured\", meaning having an additional link in the \"Insert More Content\" menu in the editor toolbar.\n\n",
|
|
6990
|
-
"defaultValue": "false"
|
|
6991
|
-
},
|
|
6992
|
-
"aliases": {
|
|
6993
|
-
"items": {
|
|
6994
|
-
"maxLength": 100,
|
|
6995
|
-
"type": "string"
|
|
6996
|
-
},
|
|
6997
|
-
"type": "array",
|
|
6998
|
-
"fieldDescription": "\n\nDefine aliases for the macro. The macro browser will open for the defined aliases as if it were this macro.\n\n"
|
|
6999
|
-
},
|
|
7000
|
-
"hidden": {
|
|
7001
|
-
"type": "boolean",
|
|
7002
|
-
"fieldDescription": "\n\nIf set to true, the macro will not appear in the macro browser.\n\n",
|
|
7003
|
-
"defaultValue": "false"
|
|
7004
|
-
},
|
|
7005
|
-
"documentation": {
|
|
7006
|
-
"$ref": "#/definitions/link",
|
|
7007
|
-
"fieldDescription": "\n\nA link to the documentation for the macro.\n\n"
|
|
7008
|
-
},
|
|
7009
|
-
"icon": {
|
|
7010
|
-
"$ref": "#/definitions/icon",
|
|
7011
|
-
"fieldDescription": "\n\nA link to the icon resource (80x80 pixels) that will be shown in the macro selection dialog.\n The URL can be absolute or relative to the add-on base URL.\n\n"
|
|
7012
|
-
},
|
|
7013
|
-
"description": {
|
|
7014
|
-
"$ref": "#/definitions/i18nProperty",
|
|
7015
|
-
"fieldDescription": "\n\nA description of the macro's functionality.\n\n"
|
|
7016
|
-
},
|
|
7017
|
-
"outputType": {
|
|
7018
|
-
"enum": [
|
|
7019
|
-
"block",
|
|
7020
|
-
"BLOCK",
|
|
7021
|
-
"inline",
|
|
7022
|
-
"INLINE"
|
|
7023
|
-
],
|
|
7024
|
-
"type": "string",
|
|
7025
|
-
"fieldDescription": "\n\nHow this macro should be placed along side other page content.\n\n",
|
|
7026
|
-
"defaultValue": "block"
|
|
7027
|
-
},
|
|
7028
|
-
"url": {
|
|
7029
|
-
"format": "uri",
|
|
7030
|
-
"type": "string",
|
|
7031
|
-
"fieldDescription": "\n\nThe link to the add-on resource that provides the macro content.\n This URL has to be relative to the add-on base URL.\n\n Additional context parameters can be passed as variables in the URL:\n <pre><code>\n {\n \"url\": \"/macro-renderer?body={macro.body}&space_id={space.id}&page_id={page.id}\"\n }\n </code></pre>\n\n Since macro bodies can be of arbitrary size and may contain sensitive data, care must be taken\n as to how its passed to your connect add-on. You have three options to gain access to the body:\n\n - If you can predict the size of your body and it is consistently less than 128 characters, you\n can include it in the GET request using the `{macro.body}` parameter.\n - If you know your macro contains a body that will often exceed the 128 character threshold\n (or is known to contain sensitive data), then you can include the `{macro.id}` parameter and\n use the Confluence REST api to call back to collect the body.\n - If you want, you can include, `{macro.body}`, `{macro.id}`, and `{macro.truncated}`. This way\n your plugin can call back to confluence only if `{macro.truncated}` is '`true`'. This will allow\n you to skip the callback if it's not needed. This would be useful for macros that don't\n contain sensitive data of an unpredictable size.\n\n\n__Note:__ If you include the `{macro.body}` in your URL you are potentially leaking sensitive data\n to any intermediate host on the internet. This may result in the body being cached or indexed\n by a third party. If you are concerned about the security of your macro, you should always use\n the `{macro.id}` and use the Confluence REST API to collect the body.\n\n Here's an example:\n\n Declare the variables that are later required to fetch the macro content in the URL:\n <pre><code>\n {\n \"url\": \"/render-macro?pageId={page.id}&pageVersion={page.version}&macroId={macro.id}\"\n }\n </code></pre>\n\n Then use the Confluence REST API to collect the body, for example directly from the iframe:\n <pre><code>\n AP.require(\"request\", function(request) {\n var pageId = getUrlParameter(\"pageId\");\n var pageVersion = getUrlParameter(\"pageVersion\");\n var macroId = getUrlParameter(\"macroId\");\n request({\n url: \"/rest/api/content/\" + pageId +\n \"/history/\" + pageVersion +\n \"/macro/id/\" + macroId,\n success: function(response) {\n var macro = JSON.parse(response);\n process(macro.body);\n }\n });\n });\n </code></pre>\n\n __Preview Mode:__ If you use the `{macro.id}` in your URL, the REST api will not return the macro body during\n a preview request, because the page has not been saved yet. You can use the `{output.type}` parameter to detect\n whether the macro is rendered in preview mode and adapt the response accordingly.\n\n __Note:__ `macro.body` will not be truncated when `renderingMethod` field was set to `POST` in static content macro.\n Refer to the [`Static Content Macros`](../static-content-macro/) for information on\n how to set this field.\n\n Currently supported variables for macros are:\n\n - `macro.hash`: The hash of the macro body (deprecated, use the macro.id)\n - `macro.id`: The id of the macro\n - `macro.body`: The macro body, truncated to 128 characters\n - `macro.truncated`: True if the macro body was truncated, false of not\n - `page.id`: The page ID, e.g. `1376295`\n - `page.title`: The page title, e.g. `My Page`\n - `page.type`: The page type, e.g. `page`\n - `page.version`: The page version, e.g. `6`\n - `space.id`: The space ID, e.g. `65537`\n - `space.key`: The space key, e.g. `AC`\n - `user.id`: The user ID, e.g. `admin` (deprecated in GDPR mode)\n - `user.key`: The user key, e.g. `ff80808143087d180143087d3a910004` (deprecated in GDPR mode)\n - `output.type`: The output type, e.g. `display` or `preview`\n\nContext parameters for macros are also required in the URL. Please see the\n [Macro Input Parameter](../macro-input-parameter/) documentation for details.\n\n"
|
|
7032
|
-
},
|
|
7033
|
-
"propertyPanel": {
|
|
7034
|
-
"properties": {
|
|
7035
|
-
"controls": {
|
|
7036
|
-
"items": {
|
|
7037
|
-
"type": "object",
|
|
7038
|
-
"anyOf": [
|
|
7039
|
-
{
|
|
7040
|
-
"properties": {
|
|
7041
|
-
"controls": {
|
|
7042
|
-
"items": {
|
|
7043
|
-
"properties": {
|
|
7044
|
-
"label": {
|
|
7045
|
-
"$ref": "#/definitions/i18nProperty",
|
|
7046
|
-
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
7047
|
-
},
|
|
7048
|
-
"type": {
|
|
7049
|
-
"enum": [
|
|
7050
|
-
"button",
|
|
7051
|
-
"BUTTON"
|
|
7052
|
-
],
|
|
7053
|
-
"type": "string",
|
|
7054
|
-
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
7055
|
-
},
|
|
7056
|
-
"key": {
|
|
7057
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
7058
|
-
"maxLength": 100,
|
|
7059
|
-
"type": "string",
|
|
7060
|
-
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
7061
|
-
}
|
|
7062
|
-
},
|
|
7063
|
-
"required": [
|
|
7064
|
-
"label",
|
|
7065
|
-
"type",
|
|
7066
|
-
"key"
|
|
7067
|
-
],
|
|
7068
|
-
"additionalProperties": true,
|
|
7069
|
-
"shortClassName": "buttonControlBean",
|
|
7070
|
-
"type": "object",
|
|
7071
|
-
"title": "ButtonControl",
|
|
7072
|
-
"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"
|
|
7073
|
-
},
|
|
7074
|
-
"type": "array",
|
|
7075
|
-
"fieldDescription": "\n\nControls which will appear in the control group\n\n"
|
|
7076
|
-
},
|
|
7077
|
-
"type": {
|
|
7078
|
-
"enum": [
|
|
7079
|
-
"group",
|
|
7080
|
-
"GROUP"
|
|
7081
|
-
],
|
|
7082
|
-
"type": "string",
|
|
7083
|
-
"fieldDescription": "\n\nThe type field must be set to 'group'\n\n"
|
|
7084
|
-
}
|
|
7085
|
-
},
|
|
7086
|
-
"required": [
|
|
7087
|
-
"controls",
|
|
7088
|
-
"type"
|
|
7089
|
-
],
|
|
7090
|
-
"shortClassName": "controlGroupBean",
|
|
7091
|
-
"type": "object",
|
|
7092
|
-
"title": "ControlGroup",
|
|
7093
|
-
"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"
|
|
7094
|
-
},
|
|
7095
|
-
{
|
|
7096
|
-
"properties": {
|
|
7097
|
-
"label": {
|
|
7098
|
-
"$ref": "#/definitions/i18nProperty",
|
|
7099
|
-
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
7100
|
-
},
|
|
7101
|
-
"type": {
|
|
7102
|
-
"enum": [
|
|
7103
|
-
"button",
|
|
7104
|
-
"BUTTON"
|
|
7105
|
-
],
|
|
7106
|
-
"type": "string",
|
|
7107
|
-
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
7108
|
-
},
|
|
7109
|
-
"key": {
|
|
7110
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
7111
|
-
"maxLength": 100,
|
|
7112
|
-
"type": "string",
|
|
7113
|
-
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
7114
|
-
}
|
|
7115
|
-
},
|
|
7116
|
-
"required": [
|
|
7117
|
-
"label",
|
|
7118
|
-
"type",
|
|
7119
|
-
"key"
|
|
7120
|
-
],
|
|
7121
|
-
"additionalProperties": true,
|
|
7122
|
-
"shortClassName": "buttonControlBean",
|
|
7123
|
-
"type": "object",
|
|
7124
|
-
"title": "ButtonControl",
|
|
7125
|
-
"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"
|
|
7126
|
-
},
|
|
6965
|
+
"defaultValue": "false"
|
|
6966
|
+
},
|
|
6967
|
+
"url": {
|
|
6968
|
+
"format": "uri",
|
|
6969
|
+
"type": "string",
|
|
6970
|
+
"fieldDescription": "\n\nThe URL to the macro configuration page in the add-on.\n\n"
|
|
6971
|
+
},
|
|
6972
|
+
"height": {
|
|
6973
|
+
"maxLength": 10,
|
|
6974
|
+
"type": "string",
|
|
6975
|
+
"fieldDescription": "\n\nThe preferred height of the edit dialog, e.g. ``300px``.\n\n"
|
|
6976
|
+
}
|
|
6977
|
+
},
|
|
6978
|
+
"required": [
|
|
6979
|
+
"url"
|
|
6980
|
+
],
|
|
6981
|
+
"shortClassName": "macroEditorBean",
|
|
6982
|
+
"type": "object",
|
|
6983
|
+
"title": "Macro Editor",
|
|
6984
|
+
"description": "\n\nMacro Parameters go a long way when it comes to macro configuration, but there are cases\n when a macro add-on needs more control over the UI.\n\n Defining a Macro Editor allows you to implement a custom UI for the macro, by specifying a\n URL to a page in your add-on which will be shown in the dialog iFrame.\n\n In order to persist custom data in your macro editor, use the Javascript\n [Confluence API](../../jsapi/confluence/) and the [Dialog API](../../jsapi/dialog/).\n For example:\n\n\n AP.require([\"confluence\", \"dialog\"], function (confluence, dialog) {\n function onSubmit() {\n var macroParams = {\n myParameter: value\n };\n confluence.saveMacro(macroParams);\n confluence.closeMacroEditor();\n return true;\n }\n\n dialog.getButton(\"submit\").bind(onSubmit);\n });\n\n In order to retrieve the custom data again when the editor is opened, use `confluence.getMacroData` (see\n [Confluence API](../../jsapi/confluence/)):\n\n AP.require(\"confluence\", function (confluence) {\n var macroData = confluence.getMacroData(function(macroParams) {\n doSomethingWith(macroParams.myParameter);\n });\n });\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"editor\": {\n \"url\": \"/map-editor\",\n \"editTitle\": {\n \"value\": \"Edit Map\"\n },\n \"insertTitle\": {\n \"value\": \"Insert Map\"\n }\n }\n }\n\n\n",
|
|
6985
|
+
"fieldDescription": "\n\nThe configuration of a custom macro editor. This is useful if the parameter input field types are\n not sufficient to configure the macro.\n\n"
|
|
6986
|
+
},
|
|
6987
|
+
"featured": {
|
|
6988
|
+
"type": "boolean",
|
|
6989
|
+
"fieldDescription": "\n\nWhether the macro should be \"featured\", meaning having an additional link in the \"Insert More Content\" menu in the editor toolbar.\n\n",
|
|
6990
|
+
"defaultValue": "false"
|
|
6991
|
+
},
|
|
6992
|
+
"aliases": {
|
|
6993
|
+
"items": {
|
|
6994
|
+
"maxLength": 100,
|
|
6995
|
+
"type": "string"
|
|
6996
|
+
},
|
|
6997
|
+
"type": "array",
|
|
6998
|
+
"fieldDescription": "\n\nDefine aliases for the macro. The macro browser will open for the defined aliases as if it were this macro.\n\n"
|
|
6999
|
+
},
|
|
7000
|
+
"hidden": {
|
|
7001
|
+
"type": "boolean",
|
|
7002
|
+
"fieldDescription": "\n\nIf set to true, the macro will not appear in the macro browser.\n\n",
|
|
7003
|
+
"defaultValue": "false"
|
|
7004
|
+
},
|
|
7005
|
+
"documentation": {
|
|
7006
|
+
"$ref": "#/definitions/link",
|
|
7007
|
+
"fieldDescription": "\n\nA link to the documentation for the macro.\n\n"
|
|
7008
|
+
},
|
|
7009
|
+
"icon": {
|
|
7010
|
+
"$ref": "#/definitions/icon",
|
|
7011
|
+
"fieldDescription": "\n\nA link to the icon resource (80x80 pixels) that will be shown in the macro selection dialog.\n The URL can be absolute or relative to the add-on base URL.\n\n"
|
|
7012
|
+
},
|
|
7013
|
+
"description": {
|
|
7014
|
+
"$ref": "#/definitions/i18nProperty",
|
|
7015
|
+
"fieldDescription": "\n\nA description of the macro's functionality.\n\n"
|
|
7016
|
+
},
|
|
7017
|
+
"outputType": {
|
|
7018
|
+
"enum": [
|
|
7019
|
+
"block",
|
|
7020
|
+
"BLOCK",
|
|
7021
|
+
"inline",
|
|
7022
|
+
"INLINE"
|
|
7023
|
+
],
|
|
7024
|
+
"type": "string",
|
|
7025
|
+
"fieldDescription": "\n\nHow this macro should be placed along side other page content.\n\n",
|
|
7026
|
+
"defaultValue": "block"
|
|
7027
|
+
},
|
|
7028
|
+
"url": {
|
|
7029
|
+
"format": "uri",
|
|
7030
|
+
"type": "string",
|
|
7031
|
+
"fieldDescription": "\n\nThe link to the add-on resource that provides the macro content.\n This URL has to be relative to the add-on base URL.\n\n Additional context parameters can be passed as variables in the URL:\n <pre><code>\n {\n \"url\": \"/macro-renderer?body={macro.body}&space_id={space.id}&page_id={page.id}\"\n }\n </code></pre>\n\n Since macro bodies can be of arbitrary size and may contain sensitive data, care must be taken\n as to how its passed to your connect add-on. You have three options to gain access to the body:\n\n - If you can predict the size of your body and it is consistently less than 128 characters, you\n can include it in the GET request using the `{macro.body}` parameter.\n - If you know your macro contains a body that will often exceed the 128 character threshold\n (or is known to contain sensitive data), then you can include the `{macro.id}` parameter and\n use the Confluence REST api to call back to collect the body.\n - If you want, you can include, `{macro.body}`, `{macro.id}`, and `{macro.truncated}`. This way\n your plugin can call back to confluence only if `{macro.truncated}` is '`true`'. This will allow\n you to skip the callback if it's not needed. This would be useful for macros that don't\n contain sensitive data of an unpredictable size.\n\n\n__Note:__ If you include the `{macro.body}` in your URL you are potentially leaking sensitive data\n to any intermediate host on the internet. This may result in the body being cached or indexed\n by a third party. If you are concerned about the security of your macro, you should always use\n the `{macro.id}` and use the Confluence REST API to collect the body.\n\n Here's an example:\n\n Declare the variables that are later required to fetch the macro content in the URL:\n <pre><code>\n {\n \"url\": \"/render-macro?pageId={page.id}&pageVersion={page.version}&macroId={macro.id}\"\n }\n </code></pre>\n\n Then use the Confluence REST API to collect the body, for example directly from the iframe:\n <pre><code>\n AP.require(\"request\", function(request) {\n var pageId = getUrlParameter(\"pageId\");\n var pageVersion = getUrlParameter(\"pageVersion\");\n var macroId = getUrlParameter(\"macroId\");\n request({\n url: \"/rest/api/content/\" + pageId +\n \"/history/\" + pageVersion +\n \"/macro/id/\" + macroId,\n success: function(response) {\n var macro = JSON.parse(response);\n process(macro.body);\n }\n });\n });\n </code></pre>\n\n __Preview Mode:__ If you use the `{macro.id}` in your URL, the REST api will not return the macro body during\n a preview request, because the page has not been saved yet. You can use the `{output.type}` parameter to detect\n whether the macro is rendered in preview mode and adapt the response accordingly.\n\n __Note:__ `macro.body` will not be truncated when `renderingMethod` field was set to `POST` in static content macro.\n Refer to the [`Static Content Macros`](../static-content-macro/) for information on\n how to set this field.\n\n Currently supported variables for macros are:\n\n - `macro.hash`: The hash of the macro body (deprecated, use the macro.id)\n - `macro.id`: The id of the macro\n - `macro.body`: The macro body, truncated to 128 characters\n - `macro.truncated`: True if the macro body was truncated, false of not\n - `page.id`: The page ID, e.g. `1376295`\n - `page.title`: The page title, e.g. `My Page`\n - `page.type`: The page type, e.g. `page`\n - `page.version`: The page version, e.g. `6`\n - `space.id`: The space ID, e.g. `65537`\n - `space.key`: The space key, e.g. `AC`\n - `user.id`: The user ID, e.g. `admin` (deprecated in GDPR mode)\n - `user.key`: The user key, e.g. `ff80808143087d180143087d3a910004` (deprecated in GDPR mode)\n - `output.type`: The output type, e.g. `display` or `preview`\n\nContext parameters for macros are also required in the URL. Please see the\n [Macro Input Parameter](../macro-input-parameter/) documentation for details.\n\n"
|
|
7032
|
+
},
|
|
7033
|
+
"propertyPanel": {
|
|
7034
|
+
"properties": {
|
|
7035
|
+
"controls": {
|
|
7036
|
+
"items": {
|
|
7037
|
+
"type": "object",
|
|
7038
|
+
"anyOf": [
|
|
7127
7039
|
{
|
|
7128
7040
|
"properties": {
|
|
7129
7041
|
"macroParameter": {
|
|
@@ -7224,6 +7136,94 @@
|
|
|
7224
7136
|
"type": "object",
|
|
7225
7137
|
"title": "ToggleGroup",
|
|
7226
7138
|
"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"
|
|
7139
|
+
},
|
|
7140
|
+
{
|
|
7141
|
+
"properties": {
|
|
7142
|
+
"controls": {
|
|
7143
|
+
"items": {
|
|
7144
|
+
"properties": {
|
|
7145
|
+
"label": {
|
|
7146
|
+
"$ref": "#/definitions/i18nProperty",
|
|
7147
|
+
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
7148
|
+
},
|
|
7149
|
+
"type": {
|
|
7150
|
+
"enum": [
|
|
7151
|
+
"button",
|
|
7152
|
+
"BUTTON"
|
|
7153
|
+
],
|
|
7154
|
+
"type": "string",
|
|
7155
|
+
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
7156
|
+
},
|
|
7157
|
+
"key": {
|
|
7158
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
7159
|
+
"maxLength": 100,
|
|
7160
|
+
"type": "string",
|
|
7161
|
+
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
7162
|
+
}
|
|
7163
|
+
},
|
|
7164
|
+
"required": [
|
|
7165
|
+
"label",
|
|
7166
|
+
"type",
|
|
7167
|
+
"key"
|
|
7168
|
+
],
|
|
7169
|
+
"additionalProperties": true,
|
|
7170
|
+
"shortClassName": "buttonControlBean",
|
|
7171
|
+
"type": "object",
|
|
7172
|
+
"title": "ButtonControl",
|
|
7173
|
+
"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"
|
|
7174
|
+
},
|
|
7175
|
+
"type": "array",
|
|
7176
|
+
"fieldDescription": "\n\nControls which will appear in the control group\n\n"
|
|
7177
|
+
},
|
|
7178
|
+
"type": {
|
|
7179
|
+
"enum": [
|
|
7180
|
+
"group",
|
|
7181
|
+
"GROUP"
|
|
7182
|
+
],
|
|
7183
|
+
"type": "string",
|
|
7184
|
+
"fieldDescription": "\n\nThe type field must be set to 'group'\n\n"
|
|
7185
|
+
}
|
|
7186
|
+
},
|
|
7187
|
+
"required": [
|
|
7188
|
+
"controls",
|
|
7189
|
+
"type"
|
|
7190
|
+
],
|
|
7191
|
+
"shortClassName": "controlGroupBean",
|
|
7192
|
+
"type": "object",
|
|
7193
|
+
"title": "ControlGroup",
|
|
7194
|
+
"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"
|
|
7195
|
+
},
|
|
7196
|
+
{
|
|
7197
|
+
"properties": {
|
|
7198
|
+
"label": {
|
|
7199
|
+
"$ref": "#/definitions/i18nProperty",
|
|
7200
|
+
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
7201
|
+
},
|
|
7202
|
+
"type": {
|
|
7203
|
+
"enum": [
|
|
7204
|
+
"button",
|
|
7205
|
+
"BUTTON"
|
|
7206
|
+
],
|
|
7207
|
+
"type": "string",
|
|
7208
|
+
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
7209
|
+
},
|
|
7210
|
+
"key": {
|
|
7211
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
7212
|
+
"maxLength": 100,
|
|
7213
|
+
"type": "string",
|
|
7214
|
+
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
7215
|
+
}
|
|
7216
|
+
},
|
|
7217
|
+
"required": [
|
|
7218
|
+
"label",
|
|
7219
|
+
"type",
|
|
7220
|
+
"key"
|
|
7221
|
+
],
|
|
7222
|
+
"additionalProperties": true,
|
|
7223
|
+
"shortClassName": "buttonControlBean",
|
|
7224
|
+
"type": "object",
|
|
7225
|
+
"title": "ButtonControl",
|
|
7226
|
+
"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"
|
|
7227
7227
|
}
|
|
7228
7228
|
]
|
|
7229
7229
|
},
|
|
@@ -7459,6 +7459,51 @@
|
|
|
7459
7459
|
"type": "object",
|
|
7460
7460
|
"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",
|
|
7461
7461
|
"anyOf": [
|
|
7462
|
+
{
|
|
7463
|
+
"properties": {
|
|
7464
|
+
"size": {
|
|
7465
|
+
"enum": [
|
|
7466
|
+
"small",
|
|
7467
|
+
"SMALL",
|
|
7468
|
+
"medium",
|
|
7469
|
+
"MEDIUM",
|
|
7470
|
+
"large",
|
|
7471
|
+
"LARGE",
|
|
7472
|
+
"x-large",
|
|
7473
|
+
"X-LARGE",
|
|
7474
|
+
"fullscreen",
|
|
7475
|
+
"FULLSCREEN",
|
|
7476
|
+
"maximum",
|
|
7477
|
+
"MAXIMUM"
|
|
7478
|
+
],
|
|
7479
|
+
"type": "string",
|
|
7480
|
+
"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"
|
|
7481
|
+
},
|
|
7482
|
+
"chrome": {
|
|
7483
|
+
"type": "boolean",
|
|
7484
|
+
"fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
|
|
7485
|
+
"defaultValue": "true"
|
|
7486
|
+
},
|
|
7487
|
+
"width": {
|
|
7488
|
+
"maxLength": 10,
|
|
7489
|
+
"type": "string",
|
|
7490
|
+
"fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
|
|
7491
|
+
},
|
|
7492
|
+
"header": {
|
|
7493
|
+
"$ref": "#/definitions/i18nProperty",
|
|
7494
|
+
"fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
|
|
7495
|
+
},
|
|
7496
|
+
"height": {
|
|
7497
|
+
"maxLength": 10,
|
|
7498
|
+
"type": "string",
|
|
7499
|
+
"fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
|
|
7500
|
+
}
|
|
7501
|
+
},
|
|
7502
|
+
"shortClassName": "dialogOptions",
|
|
7503
|
+
"type": "object",
|
|
7504
|
+
"title": "Dialog Options",
|
|
7505
|
+
"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"
|
|
7506
|
+
},
|
|
7462
7507
|
{
|
|
7463
7508
|
"properties": {
|
|
7464
7509
|
"offsetX": {
|
|
@@ -7506,51 +7551,6 @@
|
|
|
7506
7551
|
"title": "Inline Dialog Options",
|
|
7507
7552
|
"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"
|
|
7508
7553
|
},
|
|
7509
|
-
{
|
|
7510
|
-
"properties": {
|
|
7511
|
-
"size": {
|
|
7512
|
-
"enum": [
|
|
7513
|
-
"small",
|
|
7514
|
-
"SMALL",
|
|
7515
|
-
"medium",
|
|
7516
|
-
"MEDIUM",
|
|
7517
|
-
"large",
|
|
7518
|
-
"LARGE",
|
|
7519
|
-
"x-large",
|
|
7520
|
-
"X-LARGE",
|
|
7521
|
-
"fullscreen",
|
|
7522
|
-
"FULLSCREEN",
|
|
7523
|
-
"maximum",
|
|
7524
|
-
"MAXIMUM"
|
|
7525
|
-
],
|
|
7526
|
-
"type": "string",
|
|
7527
|
-
"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"
|
|
7528
|
-
},
|
|
7529
|
-
"chrome": {
|
|
7530
|
-
"type": "boolean",
|
|
7531
|
-
"fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
|
|
7532
|
-
"defaultValue": "true"
|
|
7533
|
-
},
|
|
7534
|
-
"width": {
|
|
7535
|
-
"maxLength": 10,
|
|
7536
|
-
"type": "string",
|
|
7537
|
-
"fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
|
|
7538
|
-
},
|
|
7539
|
-
"header": {
|
|
7540
|
-
"$ref": "#/definitions/i18nProperty",
|
|
7541
|
-
"fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
|
|
7542
|
-
},
|
|
7543
|
-
"height": {
|
|
7544
|
-
"maxLength": 10,
|
|
7545
|
-
"type": "string",
|
|
7546
|
-
"fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
|
|
7547
|
-
}
|
|
7548
|
-
},
|
|
7549
|
-
"shortClassName": "dialogOptions",
|
|
7550
|
-
"type": "object",
|
|
7551
|
-
"title": "Dialog Options",
|
|
7552
|
-
"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"
|
|
7553
|
-
},
|
|
7554
7554
|
{
|
|
7555
7555
|
"properties": {
|
|
7556
7556
|
"key": {
|
|
@@ -8855,10 +8855,10 @@
|
|
|
8855
8855
|
"type": "object",
|
|
8856
8856
|
"anyOf": [
|
|
8857
8857
|
{
|
|
8858
|
-
"$ref": "
|
|
8858
|
+
"$ref": "#"
|
|
8859
8859
|
},
|
|
8860
8860
|
{
|
|
8861
|
-
"$ref": "
|
|
8861
|
+
"$ref": "#/definitions/singleCondition"
|
|
8862
8862
|
}
|
|
8863
8863
|
]
|
|
8864
8864
|
},
|