@forge/manifest 3.3.1-next.3 → 3.4.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 +22 -0
- package/out/processor/basic-validation-processor.d.ts.map +1 -1
- package/out/processor/basic-validation-processor.js +2 -1
- package/out/processor/full-validation-processor.d.ts.map +1 -1
- package/out/processor/full-validation-processor.js +2 -1
- package/out/schema/manifest-schema.json +380 -315
- package/out/schema/manifest.d.ts +329 -303
- package/out/scopes/shipyard-scopes.json +18 -0
- package/out/text/errors.d.ts +3 -0
- package/out/text/errors.d.ts.map +1 -1
- package/out/text/errors.js +3 -0
- package/out/types/module-types.d.ts +1 -0
- package/out/types/module-types.d.ts.map +1 -1
- package/out/types/module-types.js +1 -0
- package/out/validators/entity-property-validator.d.ts +6 -0
- package/out/validators/entity-property-validator.d.ts.map +1 -0
- package/out/validators/entity-property-validator.js +35 -0
- package/out/validators/index.d.ts +1 -0
- package/out/validators/index.d.ts.map +1 -1
- package/out/validators/index.js +1 -0
- package/out/validators/modules-validator.d.ts.map +1 -1
- package/out/validators/modules-validator.js +1 -2
- package/out/validators/providers-validator.d.ts +2 -1
- package/out/validators/providers-validator.d.ts.map +1 -1
- package/out/validators/providers-validator.js +13 -9
- package/package.json +1 -1
|
@@ -1361,6 +1361,72 @@
|
|
|
1361
1361
|
},
|
|
1362
1362
|
"minItems": 1
|
|
1363
1363
|
},
|
|
1364
|
+
"jira:entityProperty": {
|
|
1365
|
+
"type": "array",
|
|
1366
|
+
"items": {
|
|
1367
|
+
"type": "object",
|
|
1368
|
+
"properties": {
|
|
1369
|
+
"propertyKey": {
|
|
1370
|
+
"minLength": 1,
|
|
1371
|
+
"maxLength": 255,
|
|
1372
|
+
"pattern": "^[a-zA-Z0-9-_]+$",
|
|
1373
|
+
"type": "string"
|
|
1374
|
+
},
|
|
1375
|
+
"entityType": {
|
|
1376
|
+
"default": "issue",
|
|
1377
|
+
"enum": [
|
|
1378
|
+
"issue",
|
|
1379
|
+
"project",
|
|
1380
|
+
"user"
|
|
1381
|
+
],
|
|
1382
|
+
"type": "string"
|
|
1383
|
+
},
|
|
1384
|
+
"values": {
|
|
1385
|
+
"type": "array",
|
|
1386
|
+
"items": {
|
|
1387
|
+
"type": "object",
|
|
1388
|
+
"properties": {
|
|
1389
|
+
"path": {
|
|
1390
|
+
"minLength": 1,
|
|
1391
|
+
"maxLength": 255,
|
|
1392
|
+
"pattern": "^[a-zA-Z0-9-_]+$",
|
|
1393
|
+
"type": "string"
|
|
1394
|
+
},
|
|
1395
|
+
"type": {
|
|
1396
|
+
"enum": [
|
|
1397
|
+
"date",
|
|
1398
|
+
"number",
|
|
1399
|
+
"string",
|
|
1400
|
+
"text",
|
|
1401
|
+
"user"
|
|
1402
|
+
],
|
|
1403
|
+
"type": "string"
|
|
1404
|
+
},
|
|
1405
|
+
"searchAlias": {
|
|
1406
|
+
"minLength": 1,
|
|
1407
|
+
"maxLength": 255,
|
|
1408
|
+
"pattern": "^[a-zA-Z0-9-_]+$",
|
|
1409
|
+
"type": "string"
|
|
1410
|
+
}
|
|
1411
|
+
},
|
|
1412
|
+
"required": [
|
|
1413
|
+
"path",
|
|
1414
|
+
"type"
|
|
1415
|
+
]
|
|
1416
|
+
}
|
|
1417
|
+
},
|
|
1418
|
+
"key": {
|
|
1419
|
+
"$ref": "#/definitions/ModuleKeySchema"
|
|
1420
|
+
}
|
|
1421
|
+
},
|
|
1422
|
+
"required": [
|
|
1423
|
+
"propertyKey",
|
|
1424
|
+
"values",
|
|
1425
|
+
"key"
|
|
1426
|
+
]
|
|
1427
|
+
},
|
|
1428
|
+
"minItems": 1
|
|
1429
|
+
},
|
|
1364
1430
|
"jira:customField": {
|
|
1365
1431
|
"type": "array",
|
|
1366
1432
|
"items": {
|
|
@@ -5176,10 +5242,10 @@
|
|
|
5176
5242
|
"type": "object",
|
|
5177
5243
|
"anyOf": [
|
|
5178
5244
|
{
|
|
5179
|
-
"$ref": "#/definitions/
|
|
5245
|
+
"$ref": "#/definitions/singleCondition"
|
|
5180
5246
|
},
|
|
5181
5247
|
{
|
|
5182
|
-
"$ref": "#/definitions/
|
|
5248
|
+
"$ref": "#/definitions/compositeCondition"
|
|
5183
5249
|
}
|
|
5184
5250
|
]
|
|
5185
5251
|
},
|
|
@@ -5247,10 +5313,10 @@
|
|
|
5247
5313
|
"type": "object",
|
|
5248
5314
|
"anyOf": [
|
|
5249
5315
|
{
|
|
5250
|
-
"$ref": "#/definitions/
|
|
5316
|
+
"$ref": "#/definitions/compositeCondition"
|
|
5251
5317
|
},
|
|
5252
5318
|
{
|
|
5253
|
-
"$ref": "#/definitions/
|
|
5319
|
+
"$ref": "#/definitions/singleCondition"
|
|
5254
5320
|
}
|
|
5255
5321
|
]
|
|
5256
5322
|
},
|
|
@@ -5302,10 +5368,10 @@
|
|
|
5302
5368
|
"type": "object",
|
|
5303
5369
|
"anyOf": [
|
|
5304
5370
|
{
|
|
5305
|
-
"$ref": "#/definitions/
|
|
5371
|
+
"$ref": "#/definitions/singleCondition"
|
|
5306
5372
|
},
|
|
5307
5373
|
{
|
|
5308
|
-
"$ref": "#/definitions/
|
|
5374
|
+
"$ref": "#/definitions/compositeCondition"
|
|
5309
5375
|
}
|
|
5310
5376
|
]
|
|
5311
5377
|
},
|
|
@@ -5555,6 +5621,51 @@
|
|
|
5555
5621
|
"type": "object",
|
|
5556
5622
|
"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",
|
|
5557
5623
|
"anyOf": [
|
|
5624
|
+
{
|
|
5625
|
+
"properties": {
|
|
5626
|
+
"size": {
|
|
5627
|
+
"enum": [
|
|
5628
|
+
"small",
|
|
5629
|
+
"SMALL",
|
|
5630
|
+
"medium",
|
|
5631
|
+
"MEDIUM",
|
|
5632
|
+
"large",
|
|
5633
|
+
"LARGE",
|
|
5634
|
+
"x-large",
|
|
5635
|
+
"X-LARGE",
|
|
5636
|
+
"fullscreen",
|
|
5637
|
+
"FULLSCREEN",
|
|
5638
|
+
"maximum",
|
|
5639
|
+
"MAXIMUM"
|
|
5640
|
+
],
|
|
5641
|
+
"type": "string",
|
|
5642
|
+
"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"
|
|
5643
|
+
},
|
|
5644
|
+
"chrome": {
|
|
5645
|
+
"type": "boolean",
|
|
5646
|
+
"fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
|
|
5647
|
+
"defaultValue": "true"
|
|
5648
|
+
},
|
|
5649
|
+
"width": {
|
|
5650
|
+
"maxLength": 10,
|
|
5651
|
+
"type": "string",
|
|
5652
|
+
"fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
|
|
5653
|
+
},
|
|
5654
|
+
"header": {
|
|
5655
|
+
"$ref": "#/definitions/i18nProperty",
|
|
5656
|
+
"fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
|
|
5657
|
+
},
|
|
5658
|
+
"height": {
|
|
5659
|
+
"maxLength": 10,
|
|
5660
|
+
"type": "string",
|
|
5661
|
+
"fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
|
|
5662
|
+
}
|
|
5663
|
+
},
|
|
5664
|
+
"shortClassName": "dialogOptions",
|
|
5665
|
+
"type": "object",
|
|
5666
|
+
"title": "Dialog Options",
|
|
5667
|
+
"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"
|
|
5668
|
+
},
|
|
5558
5669
|
{
|
|
5559
5670
|
"properties": {
|
|
5560
5671
|
"offsetX": {
|
|
@@ -5602,51 +5713,6 @@
|
|
|
5602
5713
|
"title": "Inline Dialog Options",
|
|
5603
5714
|
"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"
|
|
5604
5715
|
},
|
|
5605
|
-
{
|
|
5606
|
-
"properties": {
|
|
5607
|
-
"size": {
|
|
5608
|
-
"enum": [
|
|
5609
|
-
"small",
|
|
5610
|
-
"SMALL",
|
|
5611
|
-
"medium",
|
|
5612
|
-
"MEDIUM",
|
|
5613
|
-
"large",
|
|
5614
|
-
"LARGE",
|
|
5615
|
-
"x-large",
|
|
5616
|
-
"X-LARGE",
|
|
5617
|
-
"fullscreen",
|
|
5618
|
-
"FULLSCREEN",
|
|
5619
|
-
"maximum",
|
|
5620
|
-
"MAXIMUM"
|
|
5621
|
-
],
|
|
5622
|
-
"type": "string",
|
|
5623
|
-
"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"
|
|
5624
|
-
},
|
|
5625
|
-
"chrome": {
|
|
5626
|
-
"type": "boolean",
|
|
5627
|
-
"fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
|
|
5628
|
-
"defaultValue": "true"
|
|
5629
|
-
},
|
|
5630
|
-
"width": {
|
|
5631
|
-
"maxLength": 10,
|
|
5632
|
-
"type": "string",
|
|
5633
|
-
"fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
|
|
5634
|
-
},
|
|
5635
|
-
"header": {
|
|
5636
|
-
"$ref": "#/definitions/i18nProperty",
|
|
5637
|
-
"fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
|
|
5638
|
-
},
|
|
5639
|
-
"height": {
|
|
5640
|
-
"maxLength": 10,
|
|
5641
|
-
"type": "string",
|
|
5642
|
-
"fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
|
|
5643
|
-
}
|
|
5644
|
-
},
|
|
5645
|
-
"shortClassName": "dialogOptions",
|
|
5646
|
-
"type": "object",
|
|
5647
|
-
"title": "Dialog Options",
|
|
5648
|
-
"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"
|
|
5649
|
-
},
|
|
5650
5716
|
{
|
|
5651
5717
|
"properties": {
|
|
5652
5718
|
"key": {
|
|
@@ -5725,10 +5791,10 @@
|
|
|
5725
5791
|
"type": "object",
|
|
5726
5792
|
"anyOf": [
|
|
5727
5793
|
{
|
|
5728
|
-
"$ref": "
|
|
5794
|
+
"$ref": "#"
|
|
5729
5795
|
},
|
|
5730
5796
|
{
|
|
5731
|
-
"$ref": "
|
|
5797
|
+
"$ref": "#/definitions/singleCondition"
|
|
5732
5798
|
}
|
|
5733
5799
|
]
|
|
5734
5800
|
},
|
|
@@ -5830,10 +5896,10 @@
|
|
|
5830
5896
|
"type": "object",
|
|
5831
5897
|
"anyOf": [
|
|
5832
5898
|
{
|
|
5833
|
-
"$ref": "#/definitions/
|
|
5899
|
+
"$ref": "#/definitions/singleCondition"
|
|
5834
5900
|
},
|
|
5835
5901
|
{
|
|
5836
|
-
"$ref": "#/definitions/
|
|
5902
|
+
"$ref": "#/definitions/compositeCondition"
|
|
5837
5903
|
}
|
|
5838
5904
|
]
|
|
5839
5905
|
},
|
|
@@ -7501,10 +7567,10 @@
|
|
|
7501
7567
|
"type": "object",
|
|
7502
7568
|
"anyOf": [
|
|
7503
7569
|
{
|
|
7504
|
-
"$ref": "#/definitions/
|
|
7570
|
+
"$ref": "#/definitions/singleCondition"
|
|
7505
7571
|
},
|
|
7506
7572
|
{
|
|
7507
|
-
"$ref": "#/definitions/
|
|
7573
|
+
"$ref": "#/definitions/compositeCondition"
|
|
7508
7574
|
}
|
|
7509
7575
|
]
|
|
7510
7576
|
},
|
|
@@ -7627,10 +7693,10 @@
|
|
|
7627
7693
|
"type": "object",
|
|
7628
7694
|
"anyOf": [
|
|
7629
7695
|
{
|
|
7630
|
-
"$ref": "#/definitions/
|
|
7696
|
+
"$ref": "#/definitions/compositeCondition"
|
|
7631
7697
|
},
|
|
7632
7698
|
{
|
|
7633
|
-
"$ref": "#/definitions/
|
|
7699
|
+
"$ref": "#/definitions/singleCondition"
|
|
7634
7700
|
}
|
|
7635
7701
|
]
|
|
7636
7702
|
},
|
|
@@ -7749,10 +7815,10 @@
|
|
|
7749
7815
|
"type": "object",
|
|
7750
7816
|
"anyOf": [
|
|
7751
7817
|
{
|
|
7752
|
-
"$ref": "#/definitions/
|
|
7818
|
+
"$ref": "#/definitions/compositeCondition"
|
|
7753
7819
|
},
|
|
7754
7820
|
{
|
|
7755
|
-
"$ref": "#/definitions/
|
|
7821
|
+
"$ref": "#/definitions/singleCondition"
|
|
7756
7822
|
}
|
|
7757
7823
|
]
|
|
7758
7824
|
},
|
|
@@ -7880,22 +7946,6 @@
|
|
|
7880
7946
|
"type": "object",
|
|
7881
7947
|
"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",
|
|
7882
7948
|
"anyOf": [
|
|
7883
|
-
{
|
|
7884
|
-
"properties": {
|
|
7885
|
-
"key": {
|
|
7886
|
-
"maxLength": 100,
|
|
7887
|
-
"type": "string",
|
|
7888
|
-
"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"
|
|
7889
|
-
}
|
|
7890
|
-
},
|
|
7891
|
-
"required": [
|
|
7892
|
-
"key"
|
|
7893
|
-
],
|
|
7894
|
-
"shortClassName": "dialogModuleOptions",
|
|
7895
|
-
"type": "object",
|
|
7896
|
-
"title": "Dialog Module Options",
|
|
7897
|
-
"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"
|
|
7898
|
-
},
|
|
7899
7949
|
{
|
|
7900
7950
|
"properties": {
|
|
7901
7951
|
"size": {
|
|
@@ -7987,6 +8037,22 @@
|
|
|
7987
8037
|
"type": "object",
|
|
7988
8038
|
"title": "Inline Dialog Options",
|
|
7989
8039
|
"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"
|
|
8040
|
+
},
|
|
8041
|
+
{
|
|
8042
|
+
"properties": {
|
|
8043
|
+
"key": {
|
|
8044
|
+
"maxLength": 100,
|
|
8045
|
+
"type": "string",
|
|
8046
|
+
"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"
|
|
8047
|
+
}
|
|
8048
|
+
},
|
|
8049
|
+
"required": [
|
|
8050
|
+
"key"
|
|
8051
|
+
],
|
|
8052
|
+
"shortClassName": "dialogModuleOptions",
|
|
8053
|
+
"type": "object",
|
|
8054
|
+
"title": "Dialog Module Options",
|
|
8055
|
+
"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"
|
|
7990
8056
|
}
|
|
7991
8057
|
]
|
|
7992
8058
|
},
|
|
@@ -8077,10 +8143,10 @@
|
|
|
8077
8143
|
"type": "object",
|
|
8078
8144
|
"anyOf": [
|
|
8079
8145
|
{
|
|
8080
|
-
"$ref": "
|
|
8146
|
+
"$ref": "#"
|
|
8081
8147
|
},
|
|
8082
8148
|
{
|
|
8083
|
-
"$ref": "
|
|
8149
|
+
"$ref": "#/definitions/singleCondition"
|
|
8084
8150
|
}
|
|
8085
8151
|
]
|
|
8086
8152
|
},
|
|
@@ -8155,10 +8221,10 @@
|
|
|
8155
8221
|
"type": "object",
|
|
8156
8222
|
"anyOf": [
|
|
8157
8223
|
{
|
|
8158
|
-
"$ref": "#/definitions/
|
|
8224
|
+
"$ref": "#/definitions/singleCondition"
|
|
8159
8225
|
},
|
|
8160
8226
|
{
|
|
8161
|
-
"$ref": "#/definitions/
|
|
8227
|
+
"$ref": "#/definitions/compositeCondition"
|
|
8162
8228
|
}
|
|
8163
8229
|
]
|
|
8164
8230
|
},
|
|
@@ -8306,6 +8372,33 @@
|
|
|
8306
8372
|
"items": {
|
|
8307
8373
|
"type": "object",
|
|
8308
8374
|
"anyOf": [
|
|
8375
|
+
{
|
|
8376
|
+
"properties": {
|
|
8377
|
+
"condition": {
|
|
8378
|
+
"maxLength": 100,
|
|
8379
|
+
"type": "string",
|
|
8380
|
+
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
8381
|
+
},
|
|
8382
|
+
"invert": {
|
|
8383
|
+
"type": "boolean",
|
|
8384
|
+
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
8385
|
+
"defaultValue": "false"
|
|
8386
|
+
},
|
|
8387
|
+
"params": {
|
|
8388
|
+
"additionalProperties": true,
|
|
8389
|
+
"type": "object",
|
|
8390
|
+
"fieldTitle": "Object",
|
|
8391
|
+
"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"
|
|
8392
|
+
}
|
|
8393
|
+
},
|
|
8394
|
+
"required": [
|
|
8395
|
+
"condition"
|
|
8396
|
+
],
|
|
8397
|
+
"shortClassName": "singleConditionBean",
|
|
8398
|
+
"type": "object",
|
|
8399
|
+
"title": "Single Condition",
|
|
8400
|
+
"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"
|
|
8401
|
+
},
|
|
8309
8402
|
{
|
|
8310
8403
|
"properties": {
|
|
8311
8404
|
"conditions": {
|
|
@@ -8338,33 +8431,6 @@
|
|
|
8338
8431
|
"type": "object",
|
|
8339
8432
|
"title": "Composite Condition",
|
|
8340
8433
|
"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"
|
|
8341
|
-
},
|
|
8342
|
-
{
|
|
8343
|
-
"properties": {
|
|
8344
|
-
"condition": {
|
|
8345
|
-
"maxLength": 100,
|
|
8346
|
-
"type": "string",
|
|
8347
|
-
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
8348
|
-
},
|
|
8349
|
-
"invert": {
|
|
8350
|
-
"type": "boolean",
|
|
8351
|
-
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
8352
|
-
"defaultValue": "false"
|
|
8353
|
-
},
|
|
8354
|
-
"params": {
|
|
8355
|
-
"additionalProperties": true,
|
|
8356
|
-
"type": "object",
|
|
8357
|
-
"fieldTitle": "Object",
|
|
8358
|
-
"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"
|
|
8359
|
-
}
|
|
8360
|
-
},
|
|
8361
|
-
"required": [
|
|
8362
|
-
"condition"
|
|
8363
|
-
],
|
|
8364
|
-
"shortClassName": "singleConditionBean",
|
|
8365
|
-
"type": "object",
|
|
8366
|
-
"title": "Single Condition",
|
|
8367
|
-
"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"
|
|
8368
8434
|
}
|
|
8369
8435
|
]
|
|
8370
8436
|
},
|
|
@@ -8694,70 +8760,6 @@
|
|
|
8694
8760
|
"title": "ControlGroup",
|
|
8695
8761
|
"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"
|
|
8696
8762
|
},
|
|
8697
|
-
{
|
|
8698
|
-
"properties": {
|
|
8699
|
-
"macroParameter": {
|
|
8700
|
-
"maxLength": 100,
|
|
8701
|
-
"type": "string",
|
|
8702
|
-
"fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
|
|
8703
|
-
},
|
|
8704
|
-
"type": {
|
|
8705
|
-
"enum": [
|
|
8706
|
-
"text",
|
|
8707
|
-
"TEXT"
|
|
8708
|
-
],
|
|
8709
|
-
"type": "string",
|
|
8710
|
-
"fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
|
|
8711
|
-
},
|
|
8712
|
-
"key": {
|
|
8713
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
8714
|
-
"maxLength": 100,
|
|
8715
|
-
"type": "string",
|
|
8716
|
-
"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"
|
|
8717
|
-
}
|
|
8718
|
-
},
|
|
8719
|
-
"required": [
|
|
8720
|
-
"macroParameter",
|
|
8721
|
-
"type",
|
|
8722
|
-
"key"
|
|
8723
|
-
],
|
|
8724
|
-
"shortClassName": "textControlBean",
|
|
8725
|
-
"type": "object",
|
|
8726
|
-
"title": "TextControl",
|
|
8727
|
-
"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"
|
|
8728
|
-
},
|
|
8729
|
-
{
|
|
8730
|
-
"properties": {
|
|
8731
|
-
"label": {
|
|
8732
|
-
"$ref": "#/definitions/i18nProperty",
|
|
8733
|
-
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
8734
|
-
},
|
|
8735
|
-
"type": {
|
|
8736
|
-
"enum": [
|
|
8737
|
-
"button",
|
|
8738
|
-
"BUTTON"
|
|
8739
|
-
],
|
|
8740
|
-
"type": "string",
|
|
8741
|
-
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
8742
|
-
},
|
|
8743
|
-
"key": {
|
|
8744
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
8745
|
-
"maxLength": 100,
|
|
8746
|
-
"type": "string",
|
|
8747
|
-
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
8748
|
-
}
|
|
8749
|
-
},
|
|
8750
|
-
"required": [
|
|
8751
|
-
"label",
|
|
8752
|
-
"type",
|
|
8753
|
-
"key"
|
|
8754
|
-
],
|
|
8755
|
-
"additionalProperties": true,
|
|
8756
|
-
"shortClassName": "buttonControlBean",
|
|
8757
|
-
"type": "object",
|
|
8758
|
-
"title": "ButtonControl",
|
|
8759
|
-
"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"
|
|
8760
|
-
},
|
|
8761
8763
|
{
|
|
8762
8764
|
"properties": {
|
|
8763
8765
|
"controls": {
|
|
@@ -8826,6 +8828,70 @@
|
|
|
8826
8828
|
"type": "object",
|
|
8827
8829
|
"title": "ToggleGroup",
|
|
8828
8830
|
"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"
|
|
8831
|
+
},
|
|
8832
|
+
{
|
|
8833
|
+
"properties": {
|
|
8834
|
+
"macroParameter": {
|
|
8835
|
+
"maxLength": 100,
|
|
8836
|
+
"type": "string",
|
|
8837
|
+
"fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
|
|
8838
|
+
},
|
|
8839
|
+
"type": {
|
|
8840
|
+
"enum": [
|
|
8841
|
+
"text",
|
|
8842
|
+
"TEXT"
|
|
8843
|
+
],
|
|
8844
|
+
"type": "string",
|
|
8845
|
+
"fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
|
|
8846
|
+
},
|
|
8847
|
+
"key": {
|
|
8848
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
8849
|
+
"maxLength": 100,
|
|
8850
|
+
"type": "string",
|
|
8851
|
+
"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"
|
|
8852
|
+
}
|
|
8853
|
+
},
|
|
8854
|
+
"required": [
|
|
8855
|
+
"macroParameter",
|
|
8856
|
+
"type",
|
|
8857
|
+
"key"
|
|
8858
|
+
],
|
|
8859
|
+
"shortClassName": "textControlBean",
|
|
8860
|
+
"type": "object",
|
|
8861
|
+
"title": "TextControl",
|
|
8862
|
+
"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"
|
|
8863
|
+
},
|
|
8864
|
+
{
|
|
8865
|
+
"properties": {
|
|
8866
|
+
"label": {
|
|
8867
|
+
"$ref": "#/definitions/i18nProperty",
|
|
8868
|
+
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
8869
|
+
},
|
|
8870
|
+
"type": {
|
|
8871
|
+
"enum": [
|
|
8872
|
+
"button",
|
|
8873
|
+
"BUTTON"
|
|
8874
|
+
],
|
|
8875
|
+
"type": "string",
|
|
8876
|
+
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
8877
|
+
},
|
|
8878
|
+
"key": {
|
|
8879
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
8880
|
+
"maxLength": 100,
|
|
8881
|
+
"type": "string",
|
|
8882
|
+
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
8883
|
+
}
|
|
8884
|
+
},
|
|
8885
|
+
"required": [
|
|
8886
|
+
"label",
|
|
8887
|
+
"type",
|
|
8888
|
+
"key"
|
|
8889
|
+
],
|
|
8890
|
+
"additionalProperties": true,
|
|
8891
|
+
"shortClassName": "buttonControlBean",
|
|
8892
|
+
"type": "object",
|
|
8893
|
+
"title": "ButtonControl",
|
|
8894
|
+
"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"
|
|
8829
8895
|
}
|
|
8830
8896
|
]
|
|
8831
8897
|
},
|
|
@@ -9120,54 +9186,27 @@
|
|
|
9120
9186
|
"items": {
|
|
9121
9187
|
"type": "object",
|
|
9122
9188
|
"anyOf": [
|
|
9123
|
-
{
|
|
9124
|
-
"properties": {
|
|
9125
|
-
"macroParameter": {
|
|
9126
|
-
"maxLength": 100,
|
|
9127
|
-
"type": "string",
|
|
9128
|
-
"fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
|
|
9129
|
-
},
|
|
9130
|
-
"type": {
|
|
9131
|
-
"enum": [
|
|
9132
|
-
"text",
|
|
9133
|
-
"TEXT"
|
|
9134
|
-
],
|
|
9135
|
-
"type": "string",
|
|
9136
|
-
"fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
|
|
9137
|
-
},
|
|
9138
|
-
"key": {
|
|
9139
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
9140
|
-
"maxLength": 100,
|
|
9141
|
-
"type": "string",
|
|
9142
|
-
"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"
|
|
9143
|
-
}
|
|
9144
|
-
},
|
|
9145
|
-
"required": [
|
|
9146
|
-
"macroParameter",
|
|
9147
|
-
"type",
|
|
9148
|
-
"key"
|
|
9149
|
-
],
|
|
9150
|
-
"shortClassName": "textControlBean",
|
|
9151
|
-
"type": "object",
|
|
9152
|
-
"title": "TextControl",
|
|
9153
|
-
"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"
|
|
9154
|
-
},
|
|
9155
9189
|
{
|
|
9156
9190
|
"properties": {
|
|
9157
9191
|
"controls": {
|
|
9158
9192
|
"items": {
|
|
9159
9193
|
"properties": {
|
|
9194
|
+
"macroParameterValue": {
|
|
9195
|
+
"maxLength": 10000,
|
|
9196
|
+
"type": "string",
|
|
9197
|
+
"fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n"
|
|
9198
|
+
},
|
|
9160
9199
|
"label": {
|
|
9161
9200
|
"$ref": "#/definitions/i18nProperty",
|
|
9162
9201
|
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
9163
9202
|
},
|
|
9164
9203
|
"type": {
|
|
9165
9204
|
"enum": [
|
|
9166
|
-
"
|
|
9167
|
-
"
|
|
9205
|
+
"togglebutton",
|
|
9206
|
+
"TOGGLEBUTTON"
|
|
9168
9207
|
],
|
|
9169
9208
|
"type": "string",
|
|
9170
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
9209
|
+
"fieldDescription": "\n\nThe type field must be set to 'togglebutton'\n\n"
|
|
9171
9210
|
},
|
|
9172
9211
|
"key": {
|
|
9173
9212
|
"pattern": "^[a-zA-Z0-9-]+$",
|
|
@@ -9177,36 +9216,44 @@
|
|
|
9177
9216
|
}
|
|
9178
9217
|
},
|
|
9179
9218
|
"required": [
|
|
9219
|
+
"macroParameterValue",
|
|
9180
9220
|
"label",
|
|
9181
9221
|
"type",
|
|
9182
9222
|
"key"
|
|
9183
9223
|
],
|
|
9184
9224
|
"additionalProperties": true,
|
|
9185
|
-
"shortClassName": "
|
|
9225
|
+
"shortClassName": "macroToggleButtonControlBean",
|
|
9186
9226
|
"type": "object",
|
|
9187
|
-
"title": "
|
|
9188
|
-
"description": "\n\nDefines a button which
|
|
9227
|
+
"title": "ToggleButtonControl",
|
|
9228
|
+
"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"
|
|
9189
9229
|
},
|
|
9190
9230
|
"type": "array",
|
|
9191
|
-
"fieldDescription": "\n\
|
|
9231
|
+
"fieldDescription": "\n\nToggle buttons which will appear in the toggle group\n\n"
|
|
9232
|
+
},
|
|
9233
|
+
"macroParameter": {
|
|
9234
|
+
"pattern": "[-_a-z0-9\\.]+",
|
|
9235
|
+
"maxLength": 100,
|
|
9236
|
+
"type": "string",
|
|
9237
|
+
"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"
|
|
9192
9238
|
},
|
|
9193
9239
|
"type": {
|
|
9194
9240
|
"enum": [
|
|
9195
|
-
"
|
|
9196
|
-
"
|
|
9241
|
+
"togglegroup",
|
|
9242
|
+
"TOGGLEGROUP"
|
|
9197
9243
|
],
|
|
9198
9244
|
"type": "string",
|
|
9199
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
9245
|
+
"fieldDescription": "\n\nThe type field must be set to 'togglegroup'\n\n"
|
|
9200
9246
|
}
|
|
9201
9247
|
},
|
|
9202
9248
|
"required": [
|
|
9203
9249
|
"controls",
|
|
9250
|
+
"macroParameter",
|
|
9204
9251
|
"type"
|
|
9205
9252
|
],
|
|
9206
|
-
"shortClassName": "
|
|
9253
|
+
"shortClassName": "macroToggleGroupBean",
|
|
9207
9254
|
"type": "object",
|
|
9208
|
-
"title": "
|
|
9209
|
-
"description": "\n\nDefines a
|
|
9255
|
+
"title": "ToggleGroup",
|
|
9256
|
+
"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"
|
|
9210
9257
|
},
|
|
9211
9258
|
{
|
|
9212
9259
|
"properties": {
|
|
@@ -9245,22 +9292,17 @@
|
|
|
9245
9292
|
"controls": {
|
|
9246
9293
|
"items": {
|
|
9247
9294
|
"properties": {
|
|
9248
|
-
"macroParameterValue": {
|
|
9249
|
-
"maxLength": 10000,
|
|
9250
|
-
"type": "string",
|
|
9251
|
-
"fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n"
|
|
9252
|
-
},
|
|
9253
9295
|
"label": {
|
|
9254
9296
|
"$ref": "#/definitions/i18nProperty",
|
|
9255
9297
|
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
9256
9298
|
},
|
|
9257
9299
|
"type": {
|
|
9258
9300
|
"enum": [
|
|
9259
|
-
"
|
|
9260
|
-
"
|
|
9301
|
+
"button",
|
|
9302
|
+
"BUTTON"
|
|
9261
9303
|
],
|
|
9262
9304
|
"type": "string",
|
|
9263
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
9305
|
+
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
9264
9306
|
},
|
|
9265
9307
|
"key": {
|
|
9266
9308
|
"pattern": "^[a-zA-Z0-9-]+$",
|
|
@@ -9270,44 +9312,68 @@
|
|
|
9270
9312
|
}
|
|
9271
9313
|
},
|
|
9272
9314
|
"required": [
|
|
9273
|
-
"macroParameterValue",
|
|
9274
9315
|
"label",
|
|
9275
9316
|
"type",
|
|
9276
9317
|
"key"
|
|
9277
9318
|
],
|
|
9278
9319
|
"additionalProperties": true,
|
|
9279
|
-
"shortClassName": "
|
|
9320
|
+
"shortClassName": "buttonControlBean",
|
|
9280
9321
|
"type": "object",
|
|
9281
|
-
"title": "
|
|
9282
|
-
"description": "\n\nDefines a
|
|
9322
|
+
"title": "ButtonControl",
|
|
9323
|
+
"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"
|
|
9283
9324
|
},
|
|
9284
9325
|
"type": "array",
|
|
9285
|
-
"fieldDescription": "\n\
|
|
9326
|
+
"fieldDescription": "\n\nControls which will appear in the control group\n\n"
|
|
9286
9327
|
},
|
|
9328
|
+
"type": {
|
|
9329
|
+
"enum": [
|
|
9330
|
+
"group",
|
|
9331
|
+
"GROUP"
|
|
9332
|
+
],
|
|
9333
|
+
"type": "string",
|
|
9334
|
+
"fieldDescription": "\n\nThe type field must be set to 'group'\n\n"
|
|
9335
|
+
}
|
|
9336
|
+
},
|
|
9337
|
+
"required": [
|
|
9338
|
+
"controls",
|
|
9339
|
+
"type"
|
|
9340
|
+
],
|
|
9341
|
+
"shortClassName": "controlGroupBean",
|
|
9342
|
+
"type": "object",
|
|
9343
|
+
"title": "ControlGroup",
|
|
9344
|
+
"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"
|
|
9345
|
+
},
|
|
9346
|
+
{
|
|
9347
|
+
"properties": {
|
|
9287
9348
|
"macroParameter": {
|
|
9288
|
-
"pattern": "[-_a-z0-9\\.]+",
|
|
9289
9349
|
"maxLength": 100,
|
|
9290
9350
|
"type": "string",
|
|
9291
|
-
"fieldDescription": "\n\nThe
|
|
9351
|
+
"fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
|
|
9292
9352
|
},
|
|
9293
9353
|
"type": {
|
|
9294
9354
|
"enum": [
|
|
9295
|
-
"
|
|
9296
|
-
"
|
|
9355
|
+
"text",
|
|
9356
|
+
"TEXT"
|
|
9297
9357
|
],
|
|
9298
9358
|
"type": "string",
|
|
9299
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
9359
|
+
"fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
|
|
9360
|
+
},
|
|
9361
|
+
"key": {
|
|
9362
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
9363
|
+
"maxLength": 100,
|
|
9364
|
+
"type": "string",
|
|
9365
|
+
"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"
|
|
9300
9366
|
}
|
|
9301
9367
|
},
|
|
9302
9368
|
"required": [
|
|
9303
|
-
"controls",
|
|
9304
9369
|
"macroParameter",
|
|
9305
|
-
"type"
|
|
9370
|
+
"type",
|
|
9371
|
+
"key"
|
|
9306
9372
|
],
|
|
9307
|
-
"shortClassName": "
|
|
9373
|
+
"shortClassName": "textControlBean",
|
|
9308
9374
|
"type": "object",
|
|
9309
|
-
"title": "
|
|
9310
|
-
"description": "\n\nDefines a
|
|
9375
|
+
"title": "TextControl",
|
|
9376
|
+
"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"
|
|
9311
9377
|
}
|
|
9312
9378
|
]
|
|
9313
9379
|
},
|
|
@@ -9543,6 +9609,53 @@
|
|
|
9543
9609
|
"type": "object",
|
|
9544
9610
|
"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",
|
|
9545
9611
|
"anyOf": [
|
|
9612
|
+
{
|
|
9613
|
+
"properties": {
|
|
9614
|
+
"offsetX": {
|
|
9615
|
+
"maxLength": 10,
|
|
9616
|
+
"type": "string",
|
|
9617
|
+
"fieldDescription": "\n\nSets an offset distance of the inline-dialog from the trigger element along the x-axis in pixels\n\n"
|
|
9618
|
+
},
|
|
9619
|
+
"offsetY": {
|
|
9620
|
+
"maxLength": 10,
|
|
9621
|
+
"type": "string",
|
|
9622
|
+
"fieldDescription": "\n\nSets an offset distance of the inline-dialog from the trigger element along the y-axis in pixels\n\n"
|
|
9623
|
+
},
|
|
9624
|
+
"width": {
|
|
9625
|
+
"maxLength": 10,
|
|
9626
|
+
"type": "string",
|
|
9627
|
+
"fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
|
|
9628
|
+
},
|
|
9629
|
+
"onTop": {
|
|
9630
|
+
"type": "boolean",
|
|
9631
|
+
"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"
|
|
9632
|
+
},
|
|
9633
|
+
"showDelay": {
|
|
9634
|
+
"type": "integer",
|
|
9635
|
+
"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"
|
|
9636
|
+
},
|
|
9637
|
+
"closeOthers": {
|
|
9638
|
+
"type": "boolean",
|
|
9639
|
+
"fieldDescription": "\n\nDetermines if all other dialogs on the screen are closed when this one is opened\n\n"
|
|
9640
|
+
},
|
|
9641
|
+
"persistent": {
|
|
9642
|
+
"type": "boolean",
|
|
9643
|
+
"fieldDescription": "\n\nThis option, ignores the 'closeOthers' option\n\n"
|
|
9644
|
+
},
|
|
9645
|
+
"onHover": {
|
|
9646
|
+
"type": "boolean",
|
|
9647
|
+
"fieldDescription": "\n\nDetermines whether the inline-Dialog will show on a mouseOver or mouseClick of the trigger\n\n"
|
|
9648
|
+
},
|
|
9649
|
+
"isRelativeToMouse": {
|
|
9650
|
+
"type": "boolean",
|
|
9651
|
+
"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"
|
|
9652
|
+
}
|
|
9653
|
+
},
|
|
9654
|
+
"shortClassName": "inlineDialogOptions",
|
|
9655
|
+
"type": "object",
|
|
9656
|
+
"title": "Inline Dialog Options",
|
|
9657
|
+
"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"
|
|
9658
|
+
},
|
|
9546
9659
|
{
|
|
9547
9660
|
"properties": {
|
|
9548
9661
|
"key": {
|
|
@@ -9603,53 +9716,6 @@
|
|
|
9603
9716
|
"type": "object",
|
|
9604
9717
|
"title": "Dialog Options",
|
|
9605
9718
|
"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"
|
|
9606
|
-
},
|
|
9607
|
-
{
|
|
9608
|
-
"properties": {
|
|
9609
|
-
"offsetX": {
|
|
9610
|
-
"maxLength": 10,
|
|
9611
|
-
"type": "string",
|
|
9612
|
-
"fieldDescription": "\n\nSets an offset distance of the inline-dialog from the trigger element along the x-axis in pixels\n\n"
|
|
9613
|
-
},
|
|
9614
|
-
"offsetY": {
|
|
9615
|
-
"maxLength": 10,
|
|
9616
|
-
"type": "string",
|
|
9617
|
-
"fieldDescription": "\n\nSets an offset distance of the inline-dialog from the trigger element along the y-axis in pixels\n\n"
|
|
9618
|
-
},
|
|
9619
|
-
"width": {
|
|
9620
|
-
"maxLength": 10,
|
|
9621
|
-
"type": "string",
|
|
9622
|
-
"fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
|
|
9623
|
-
},
|
|
9624
|
-
"onTop": {
|
|
9625
|
-
"type": "boolean",
|
|
9626
|
-
"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"
|
|
9627
|
-
},
|
|
9628
|
-
"showDelay": {
|
|
9629
|
-
"type": "integer",
|
|
9630
|
-
"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"
|
|
9631
|
-
},
|
|
9632
|
-
"closeOthers": {
|
|
9633
|
-
"type": "boolean",
|
|
9634
|
-
"fieldDescription": "\n\nDetermines if all other dialogs on the screen are closed when this one is opened\n\n"
|
|
9635
|
-
},
|
|
9636
|
-
"persistent": {
|
|
9637
|
-
"type": "boolean",
|
|
9638
|
-
"fieldDescription": "\n\nThis option, ignores the 'closeOthers' option\n\n"
|
|
9639
|
-
},
|
|
9640
|
-
"onHover": {
|
|
9641
|
-
"type": "boolean",
|
|
9642
|
-
"fieldDescription": "\n\nDetermines whether the inline-Dialog will show on a mouseOver or mouseClick of the trigger\n\n"
|
|
9643
|
-
},
|
|
9644
|
-
"isRelativeToMouse": {
|
|
9645
|
-
"type": "boolean",
|
|
9646
|
-
"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"
|
|
9647
|
-
}
|
|
9648
|
-
},
|
|
9649
|
-
"shortClassName": "inlineDialogOptions",
|
|
9650
|
-
"type": "object",
|
|
9651
|
-
"title": "Inline Dialog Options",
|
|
9652
|
-
"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"
|
|
9653
9719
|
}
|
|
9654
9720
|
]
|
|
9655
9721
|
},
|
|
@@ -10233,7 +10299,6 @@
|
|
|
10233
10299
|
"required": [
|
|
10234
10300
|
"authorization",
|
|
10235
10301
|
"exchange",
|
|
10236
|
-
"revokeToken",
|
|
10237
10302
|
"retrieveProfile"
|
|
10238
10303
|
],
|
|
10239
10304
|
"additionalProperties": false,
|
|
@@ -10975,6 +11040,33 @@
|
|
|
10975
11040
|
"title": "Icon",
|
|
10976
11041
|
"description": "\n\nDefines an icon to display.\n\n <h3>Example</h3>\n\n\n\n\n\n {\n \"icon\": {\n \"width\": 16,\n \"height\": 16,\n \"url\": \"/my-icon.png\"\n }\n }\n\n\n"
|
|
10977
11042
|
},
|
|
11043
|
+
"singleCondition": {
|
|
11044
|
+
"properties": {
|
|
11045
|
+
"condition": {
|
|
11046
|
+
"maxLength": 100,
|
|
11047
|
+
"type": "string",
|
|
11048
|
+
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
11049
|
+
},
|
|
11050
|
+
"invert": {
|
|
11051
|
+
"type": "boolean",
|
|
11052
|
+
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
11053
|
+
"defaultValue": "false"
|
|
11054
|
+
},
|
|
11055
|
+
"params": {
|
|
11056
|
+
"additionalProperties": true,
|
|
11057
|
+
"type": "object",
|
|
11058
|
+
"fieldTitle": "Object",
|
|
11059
|
+
"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"
|
|
11060
|
+
}
|
|
11061
|
+
},
|
|
11062
|
+
"required": [
|
|
11063
|
+
"condition"
|
|
11064
|
+
],
|
|
11065
|
+
"shortClassName": "singleConditionBean",
|
|
11066
|
+
"type": "object",
|
|
11067
|
+
"title": "Single Condition",
|
|
11068
|
+
"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"
|
|
11069
|
+
},
|
|
10978
11070
|
"compositeCondition": {
|
|
10979
11071
|
"properties": {
|
|
10980
11072
|
"conditions": {
|
|
@@ -11008,33 +11100,6 @@
|
|
|
11008
11100
|
"title": "Composite Condition",
|
|
11009
11101
|
"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"
|
|
11010
11102
|
},
|
|
11011
|
-
"singleCondition": {
|
|
11012
|
-
"properties": {
|
|
11013
|
-
"condition": {
|
|
11014
|
-
"maxLength": 100,
|
|
11015
|
-
"type": "string",
|
|
11016
|
-
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
11017
|
-
},
|
|
11018
|
-
"invert": {
|
|
11019
|
-
"type": "boolean",
|
|
11020
|
-
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
11021
|
-
"defaultValue": "false"
|
|
11022
|
-
},
|
|
11023
|
-
"params": {
|
|
11024
|
-
"additionalProperties": true,
|
|
11025
|
-
"type": "object",
|
|
11026
|
-
"fieldTitle": "Object",
|
|
11027
|
-
"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"
|
|
11028
|
-
}
|
|
11029
|
-
},
|
|
11030
|
-
"required": [
|
|
11031
|
-
"condition"
|
|
11032
|
-
],
|
|
11033
|
-
"shortClassName": "singleConditionBean",
|
|
11034
|
-
"type": "object",
|
|
11035
|
-
"title": "Single Condition",
|
|
11036
|
-
"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"
|
|
11037
|
-
},
|
|
11038
11103
|
"webPanelLayout": {
|
|
11039
11104
|
"properties": {
|
|
11040
11105
|
"width": {
|