@forge/manifest 3.4.0-next.6 → 3.4.0-next.9
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 +18 -0
- package/out/schema/manifest-schema.json +379 -348
- package/out/schema/manifest.d.ts +424 -408
- package/out/text/errors.d.ts +4 -1
- package/out/text/errors.d.ts.map +1 -1
- package/out/text/errors.js +4 -1
- 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/modules-validator.d.ts.map +1 -1
- package/out/validators/modules-validator.js +8 -3
- package/package.json +1 -1
|
@@ -3892,6 +3892,37 @@
|
|
|
3892
3892
|
},
|
|
3893
3893
|
"minItems": 1
|
|
3894
3894
|
},
|
|
3895
|
+
"jira:workflowCondition": {
|
|
3896
|
+
"type": "array",
|
|
3897
|
+
"items": {
|
|
3898
|
+
"type": "object",
|
|
3899
|
+
"properties": {
|
|
3900
|
+
"name": {
|
|
3901
|
+
"minLength": 1,
|
|
3902
|
+
"maxLength": 255,
|
|
3903
|
+
"type": "string"
|
|
3904
|
+
},
|
|
3905
|
+
"description": {
|
|
3906
|
+
"minLength": 1,
|
|
3907
|
+
"maxLength": 1000,
|
|
3908
|
+
"type": "string"
|
|
3909
|
+
},
|
|
3910
|
+
"expression": {
|
|
3911
|
+
"type": "string"
|
|
3912
|
+
},
|
|
3913
|
+
"key": {
|
|
3914
|
+
"$ref": "#/definitions/ModuleKeySchema"
|
|
3915
|
+
}
|
|
3916
|
+
},
|
|
3917
|
+
"required": [
|
|
3918
|
+
"description",
|
|
3919
|
+
"expression",
|
|
3920
|
+
"name",
|
|
3921
|
+
"key"
|
|
3922
|
+
]
|
|
3923
|
+
},
|
|
3924
|
+
"minItems": 1
|
|
3925
|
+
},
|
|
3895
3926
|
"compass:adminPage": {
|
|
3896
3927
|
"type": "array",
|
|
3897
3928
|
"items": {
|
|
@@ -5242,10 +5273,10 @@
|
|
|
5242
5273
|
"type": "object",
|
|
5243
5274
|
"anyOf": [
|
|
5244
5275
|
{
|
|
5245
|
-
"$ref": "#/definitions/
|
|
5276
|
+
"$ref": "#/definitions/compositeCondition"
|
|
5246
5277
|
},
|
|
5247
5278
|
{
|
|
5248
|
-
"$ref": "#/definitions/
|
|
5279
|
+
"$ref": "#/definitions/singleCondition"
|
|
5249
5280
|
}
|
|
5250
5281
|
]
|
|
5251
5282
|
},
|
|
@@ -5313,10 +5344,10 @@
|
|
|
5313
5344
|
"type": "object",
|
|
5314
5345
|
"anyOf": [
|
|
5315
5346
|
{
|
|
5316
|
-
"$ref": "#/definitions/
|
|
5347
|
+
"$ref": "#/definitions/singleCondition"
|
|
5317
5348
|
},
|
|
5318
5349
|
{
|
|
5319
|
-
"$ref": "#/definitions/
|
|
5350
|
+
"$ref": "#/definitions/compositeCondition"
|
|
5320
5351
|
}
|
|
5321
5352
|
]
|
|
5322
5353
|
},
|
|
@@ -5432,10 +5463,10 @@
|
|
|
5432
5463
|
"type": "object",
|
|
5433
5464
|
"anyOf": [
|
|
5434
5465
|
{
|
|
5435
|
-
"$ref": "#/definitions/
|
|
5466
|
+
"$ref": "#/definitions/compositeCondition"
|
|
5436
5467
|
},
|
|
5437
5468
|
{
|
|
5438
|
-
"$ref": "#/definitions/
|
|
5469
|
+
"$ref": "#/definitions/singleCondition"
|
|
5439
5470
|
}
|
|
5440
5471
|
]
|
|
5441
5472
|
},
|
|
@@ -5490,10 +5521,10 @@
|
|
|
5490
5521
|
"type": "object",
|
|
5491
5522
|
"anyOf": [
|
|
5492
5523
|
{
|
|
5493
|
-
"$ref": "#/definitions/
|
|
5524
|
+
"$ref": "#/definitions/compositeCondition"
|
|
5494
5525
|
},
|
|
5495
5526
|
{
|
|
5496
|
-
"$ref": "#/definitions/
|
|
5527
|
+
"$ref": "#/definitions/singleCondition"
|
|
5497
5528
|
}
|
|
5498
5529
|
]
|
|
5499
5530
|
},
|
|
@@ -5548,10 +5579,10 @@
|
|
|
5548
5579
|
"type": "object",
|
|
5549
5580
|
"anyOf": [
|
|
5550
5581
|
{
|
|
5551
|
-
"$ref": "#/definitions/
|
|
5582
|
+
"$ref": "#/definitions/compositeCondition"
|
|
5552
5583
|
},
|
|
5553
5584
|
{
|
|
5554
|
-
"$ref": "#/definitions/
|
|
5585
|
+
"$ref": "#/definitions/singleCondition"
|
|
5555
5586
|
}
|
|
5556
5587
|
]
|
|
5557
5588
|
},
|
|
@@ -5621,51 +5652,6 @@
|
|
|
5621
5652
|
"type": "object",
|
|
5622
5653
|
"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",
|
|
5623
5654
|
"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
|
-
},
|
|
5669
5655
|
{
|
|
5670
5656
|
"properties": {
|
|
5671
5657
|
"offsetX": {
|
|
@@ -5728,6 +5714,51 @@
|
|
|
5728
5714
|
"type": "object",
|
|
5729
5715
|
"title": "Dialog Module Options",
|
|
5730
5716
|
"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"
|
|
5717
|
+
},
|
|
5718
|
+
{
|
|
5719
|
+
"properties": {
|
|
5720
|
+
"size": {
|
|
5721
|
+
"enum": [
|
|
5722
|
+
"small",
|
|
5723
|
+
"SMALL",
|
|
5724
|
+
"medium",
|
|
5725
|
+
"MEDIUM",
|
|
5726
|
+
"large",
|
|
5727
|
+
"LARGE",
|
|
5728
|
+
"x-large",
|
|
5729
|
+
"X-LARGE",
|
|
5730
|
+
"fullscreen",
|
|
5731
|
+
"FULLSCREEN",
|
|
5732
|
+
"maximum",
|
|
5733
|
+
"MAXIMUM"
|
|
5734
|
+
],
|
|
5735
|
+
"type": "string",
|
|
5736
|
+
"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"
|
|
5737
|
+
},
|
|
5738
|
+
"chrome": {
|
|
5739
|
+
"type": "boolean",
|
|
5740
|
+
"fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
|
|
5741
|
+
"defaultValue": "true"
|
|
5742
|
+
},
|
|
5743
|
+
"width": {
|
|
5744
|
+
"maxLength": 10,
|
|
5745
|
+
"type": "string",
|
|
5746
|
+
"fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
|
|
5747
|
+
},
|
|
5748
|
+
"header": {
|
|
5749
|
+
"$ref": "#/definitions/i18nProperty",
|
|
5750
|
+
"fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
|
|
5751
|
+
},
|
|
5752
|
+
"height": {
|
|
5753
|
+
"maxLength": 10,
|
|
5754
|
+
"type": "string",
|
|
5755
|
+
"fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
|
|
5756
|
+
}
|
|
5757
|
+
},
|
|
5758
|
+
"shortClassName": "dialogOptions",
|
|
5759
|
+
"type": "object",
|
|
5760
|
+
"title": "Dialog Options",
|
|
5761
|
+
"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"
|
|
5731
5762
|
}
|
|
5732
5763
|
]
|
|
5733
5764
|
},
|
|
@@ -5896,10 +5927,10 @@
|
|
|
5896
5927
|
"type": "object",
|
|
5897
5928
|
"anyOf": [
|
|
5898
5929
|
{
|
|
5899
|
-
"$ref": "#/definitions/
|
|
5930
|
+
"$ref": "#/definitions/compositeCondition"
|
|
5900
5931
|
},
|
|
5901
5932
|
{
|
|
5902
|
-
"$ref": "#/definitions/
|
|
5933
|
+
"$ref": "#/definitions/singleCondition"
|
|
5903
5934
|
}
|
|
5904
5935
|
]
|
|
5905
5936
|
},
|
|
@@ -6117,10 +6148,10 @@
|
|
|
6117
6148
|
"type": "object",
|
|
6118
6149
|
"anyOf": [
|
|
6119
6150
|
{
|
|
6120
|
-
"$ref": "#/definitions/
|
|
6151
|
+
"$ref": "#/definitions/singleCondition"
|
|
6121
6152
|
},
|
|
6122
6153
|
{
|
|
6123
|
-
"$ref": "#/definitions/
|
|
6154
|
+
"$ref": "#/definitions/compositeCondition"
|
|
6124
6155
|
}
|
|
6125
6156
|
]
|
|
6126
6157
|
},
|
|
@@ -6260,10 +6291,10 @@
|
|
|
6260
6291
|
"type": "object",
|
|
6261
6292
|
"anyOf": [
|
|
6262
6293
|
{
|
|
6263
|
-
"$ref": "#/definitions/
|
|
6294
|
+
"$ref": "#/definitions/compositeCondition"
|
|
6264
6295
|
},
|
|
6265
6296
|
{
|
|
6266
|
-
"$ref": "#/definitions/
|
|
6297
|
+
"$ref": "#/definitions/singleCondition"
|
|
6267
6298
|
}
|
|
6268
6299
|
]
|
|
6269
6300
|
},
|
|
@@ -6545,10 +6576,10 @@
|
|
|
6545
6576
|
"type": "object",
|
|
6546
6577
|
"anyOf": [
|
|
6547
6578
|
{
|
|
6548
|
-
"$ref": "#/definitions/
|
|
6579
|
+
"$ref": "#/definitions/compositeCondition"
|
|
6549
6580
|
},
|
|
6550
6581
|
{
|
|
6551
|
-
"$ref": "#/definitions/
|
|
6582
|
+
"$ref": "#/definitions/singleCondition"
|
|
6552
6583
|
}
|
|
6553
6584
|
]
|
|
6554
6585
|
},
|
|
@@ -6586,10 +6617,10 @@
|
|
|
6586
6617
|
"type": "object",
|
|
6587
6618
|
"anyOf": [
|
|
6588
6619
|
{
|
|
6589
|
-
"$ref": "#/definitions/
|
|
6620
|
+
"$ref": "#/definitions/compositeCondition"
|
|
6590
6621
|
},
|
|
6591
6622
|
{
|
|
6592
|
-
"$ref": "#/definitions/
|
|
6623
|
+
"$ref": "#/definitions/singleCondition"
|
|
6593
6624
|
}
|
|
6594
6625
|
]
|
|
6595
6626
|
},
|
|
@@ -6676,12 +6707,42 @@
|
|
|
6676
6707
|
"items": {
|
|
6677
6708
|
"type": "object",
|
|
6678
6709
|
"anyOf": [
|
|
6710
|
+
{
|
|
6711
|
+
"properties": {
|
|
6712
|
+
"condition": {
|
|
6713
|
+
"maxLength": 100,
|
|
6714
|
+
"type": "string",
|
|
6715
|
+
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
6716
|
+
},
|
|
6717
|
+
"invert": {
|
|
6718
|
+
"type": "boolean",
|
|
6719
|
+
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
6720
|
+
"defaultValue": "false"
|
|
6721
|
+
},
|
|
6722
|
+
"params": {
|
|
6723
|
+
"additionalProperties": true,
|
|
6724
|
+
"type": "object",
|
|
6725
|
+
"fieldTitle": "Object",
|
|
6726
|
+
"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"
|
|
6727
|
+
}
|
|
6728
|
+
},
|
|
6729
|
+
"required": [
|
|
6730
|
+
"condition"
|
|
6731
|
+
],
|
|
6732
|
+
"shortClassName": "singleConditionBean",
|
|
6733
|
+
"type": "object",
|
|
6734
|
+
"title": "Single Condition",
|
|
6735
|
+
"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"
|
|
6736
|
+
},
|
|
6679
6737
|
{
|
|
6680
6738
|
"properties": {
|
|
6681
6739
|
"conditions": {
|
|
6682
6740
|
"items": {
|
|
6683
6741
|
"type": "object",
|
|
6684
6742
|
"anyOf": [
|
|
6743
|
+
{
|
|
6744
|
+
"$ref": "#/definitions/singleCondition"
|
|
6745
|
+
},
|
|
6685
6746
|
{
|
|
6686
6747
|
"properties": {
|
|
6687
6748
|
"conditions": {
|
|
@@ -6689,10 +6750,10 @@
|
|
|
6689
6750
|
"type": "object",
|
|
6690
6751
|
"anyOf": [
|
|
6691
6752
|
{
|
|
6692
|
-
"$ref": "
|
|
6753
|
+
"$ref": "#/definitions/singleCondition"
|
|
6693
6754
|
},
|
|
6694
6755
|
{
|
|
6695
|
-
"$ref": "
|
|
6756
|
+
"$ref": "#"
|
|
6696
6757
|
}
|
|
6697
6758
|
]
|
|
6698
6759
|
},
|
|
@@ -6714,9 +6775,6 @@
|
|
|
6714
6775
|
"type": "object",
|
|
6715
6776
|
"title": "Composite Condition",
|
|
6716
6777
|
"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"
|
|
6717
|
-
},
|
|
6718
|
-
{
|
|
6719
|
-
"$ref": "#/definitions/singleCondition"
|
|
6720
6778
|
}
|
|
6721
6779
|
]
|
|
6722
6780
|
},
|
|
@@ -6738,33 +6796,6 @@
|
|
|
6738
6796
|
"type": "object",
|
|
6739
6797
|
"title": "Composite Condition",
|
|
6740
6798
|
"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"
|
|
6741
|
-
},
|
|
6742
|
-
{
|
|
6743
|
-
"properties": {
|
|
6744
|
-
"condition": {
|
|
6745
|
-
"maxLength": 100,
|
|
6746
|
-
"type": "string",
|
|
6747
|
-
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
6748
|
-
},
|
|
6749
|
-
"invert": {
|
|
6750
|
-
"type": "boolean",
|
|
6751
|
-
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
6752
|
-
"defaultValue": "false"
|
|
6753
|
-
},
|
|
6754
|
-
"params": {
|
|
6755
|
-
"additionalProperties": true,
|
|
6756
|
-
"type": "object",
|
|
6757
|
-
"fieldTitle": "Object",
|
|
6758
|
-
"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"
|
|
6759
|
-
}
|
|
6760
|
-
},
|
|
6761
|
-
"required": [
|
|
6762
|
-
"condition"
|
|
6763
|
-
],
|
|
6764
|
-
"shortClassName": "singleConditionBean",
|
|
6765
|
-
"type": "object",
|
|
6766
|
-
"title": "Single Condition",
|
|
6767
|
-
"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"
|
|
6768
6799
|
}
|
|
6769
6800
|
]
|
|
6770
6801
|
},
|
|
@@ -6991,12 +7022,42 @@
|
|
|
6991
7022
|
"items": {
|
|
6992
7023
|
"type": "object",
|
|
6993
7024
|
"anyOf": [
|
|
7025
|
+
{
|
|
7026
|
+
"properties": {
|
|
7027
|
+
"condition": {
|
|
7028
|
+
"maxLength": 100,
|
|
7029
|
+
"type": "string",
|
|
7030
|
+
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
7031
|
+
},
|
|
7032
|
+
"invert": {
|
|
7033
|
+
"type": "boolean",
|
|
7034
|
+
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
7035
|
+
"defaultValue": "false"
|
|
7036
|
+
},
|
|
7037
|
+
"params": {
|
|
7038
|
+
"additionalProperties": true,
|
|
7039
|
+
"type": "object",
|
|
7040
|
+
"fieldTitle": "Object",
|
|
7041
|
+
"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"
|
|
7042
|
+
}
|
|
7043
|
+
},
|
|
7044
|
+
"required": [
|
|
7045
|
+
"condition"
|
|
7046
|
+
],
|
|
7047
|
+
"shortClassName": "singleConditionBean",
|
|
7048
|
+
"type": "object",
|
|
7049
|
+
"title": "Single Condition",
|
|
7050
|
+
"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"
|
|
7051
|
+
},
|
|
6994
7052
|
{
|
|
6995
7053
|
"properties": {
|
|
6996
7054
|
"conditions": {
|
|
6997
7055
|
"items": {
|
|
6998
7056
|
"type": "object",
|
|
6999
7057
|
"anyOf": [
|
|
7058
|
+
{
|
|
7059
|
+
"$ref": "#/definitions/singleCondition"
|
|
7060
|
+
},
|
|
7000
7061
|
{
|
|
7001
7062
|
"properties": {
|
|
7002
7063
|
"conditions": {
|
|
@@ -7004,10 +7065,10 @@
|
|
|
7004
7065
|
"type": "object",
|
|
7005
7066
|
"anyOf": [
|
|
7006
7067
|
{
|
|
7007
|
-
"$ref": "
|
|
7068
|
+
"$ref": "#/definitions/singleCondition"
|
|
7008
7069
|
},
|
|
7009
7070
|
{
|
|
7010
|
-
"$ref": "
|
|
7071
|
+
"$ref": "#"
|
|
7011
7072
|
}
|
|
7012
7073
|
]
|
|
7013
7074
|
},
|
|
@@ -7029,9 +7090,6 @@
|
|
|
7029
7090
|
"type": "object",
|
|
7030
7091
|
"title": "Composite Condition",
|
|
7031
7092
|
"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"
|
|
7032
|
-
},
|
|
7033
|
-
{
|
|
7034
|
-
"$ref": "#/definitions/singleCondition"
|
|
7035
7093
|
}
|
|
7036
7094
|
]
|
|
7037
7095
|
},
|
|
@@ -7053,33 +7111,6 @@
|
|
|
7053
7111
|
"type": "object",
|
|
7054
7112
|
"title": "Composite Condition",
|
|
7055
7113
|
"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"
|
|
7056
|
-
},
|
|
7057
|
-
{
|
|
7058
|
-
"properties": {
|
|
7059
|
-
"condition": {
|
|
7060
|
-
"maxLength": 100,
|
|
7061
|
-
"type": "string",
|
|
7062
|
-
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
7063
|
-
},
|
|
7064
|
-
"invert": {
|
|
7065
|
-
"type": "boolean",
|
|
7066
|
-
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
7067
|
-
"defaultValue": "false"
|
|
7068
|
-
},
|
|
7069
|
-
"params": {
|
|
7070
|
-
"additionalProperties": true,
|
|
7071
|
-
"type": "object",
|
|
7072
|
-
"fieldTitle": "Object",
|
|
7073
|
-
"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"
|
|
7074
|
-
}
|
|
7075
|
-
},
|
|
7076
|
-
"required": [
|
|
7077
|
-
"condition"
|
|
7078
|
-
],
|
|
7079
|
-
"shortClassName": "singleConditionBean",
|
|
7080
|
-
"type": "object",
|
|
7081
|
-
"title": "Single Condition",
|
|
7082
|
-
"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"
|
|
7083
7114
|
}
|
|
7084
7115
|
]
|
|
7085
7116
|
},
|
|
@@ -7306,21 +7337,6 @@
|
|
|
7306
7337
|
"type": "object",
|
|
7307
7338
|
"fieldDescription": "\n\nThe error message that will be shown if the validator rejects the transition by returning <code>false</code>.\n <p>\n This can be either a static [i18n property](../i18n-property/), or an object containing the \"expression\" property,\n with a Jira expression that returns the error message dynamically, based on the current transition or configuration.\n\n",
|
|
7308
7339
|
"anyOf": [
|
|
7309
|
-
{
|
|
7310
|
-
"properties": {
|
|
7311
|
-
"expression": {
|
|
7312
|
-
"type": "string",
|
|
7313
|
-
"fieldDescription": "\n\nThe Jira expression that will return an error message if the validator rejects a transition.\n\n"
|
|
7314
|
-
}
|
|
7315
|
-
},
|
|
7316
|
-
"required": [
|
|
7317
|
-
"expression"
|
|
7318
|
-
],
|
|
7319
|
-
"shortClassName": "validatorJiraExpressionErrorMessage",
|
|
7320
|
-
"type": "object",
|
|
7321
|
-
"title": "Jira Expression Error Message",
|
|
7322
|
-
"description": "\n\nA Jira expression that will be evaluated if the workflow validator fails.\n The string returned by the Jira expression will be displayed as the error message for the failed transition.\n\n"
|
|
7323
|
-
},
|
|
7324
7340
|
{
|
|
7325
7341
|
"properties": {
|
|
7326
7342
|
"value": {
|
|
@@ -7341,6 +7357,21 @@
|
|
|
7341
7357
|
"type": "object",
|
|
7342
7358
|
"title": "i18n Property",
|
|
7343
7359
|
"description": "\n\nRepresents a string that can be resolved via a localization properties file. You can use the same `i18n Property` key\n and value in multiple places if you like, but identical keys must have identical values.\n\n <h3>Example</h3>\n\n\n\n\n\n {\n \"value\": \"My text\"\n }\n\n\n"
|
|
7360
|
+
},
|
|
7361
|
+
{
|
|
7362
|
+
"properties": {
|
|
7363
|
+
"expression": {
|
|
7364
|
+
"type": "string",
|
|
7365
|
+
"fieldDescription": "\n\nThe Jira expression that will return an error message if the validator rejects a transition.\n\n"
|
|
7366
|
+
}
|
|
7367
|
+
},
|
|
7368
|
+
"required": [
|
|
7369
|
+
"expression"
|
|
7370
|
+
],
|
|
7371
|
+
"shortClassName": "validatorJiraExpressionErrorMessage",
|
|
7372
|
+
"type": "object",
|
|
7373
|
+
"title": "Jira Expression Error Message",
|
|
7374
|
+
"description": "\n\nA Jira expression that will be evaluated if the workflow validator fails.\n The string returned by the Jira expression will be displayed as the error message for the failed transition.\n\n"
|
|
7344
7375
|
}
|
|
7345
7376
|
]
|
|
7346
7377
|
},
|
|
@@ -7638,10 +7669,10 @@
|
|
|
7638
7669
|
"type": "object",
|
|
7639
7670
|
"anyOf": [
|
|
7640
7671
|
{
|
|
7641
|
-
"$ref": "#/definitions/
|
|
7672
|
+
"$ref": "#/definitions/compositeCondition"
|
|
7642
7673
|
},
|
|
7643
7674
|
{
|
|
7644
|
-
"$ref": "#/definitions/
|
|
7675
|
+
"$ref": "#/definitions/singleCondition"
|
|
7645
7676
|
}
|
|
7646
7677
|
]
|
|
7647
7678
|
},
|
|
@@ -7693,10 +7724,10 @@
|
|
|
7693
7724
|
"type": "object",
|
|
7694
7725
|
"anyOf": [
|
|
7695
7726
|
{
|
|
7696
|
-
"$ref": "#/definitions/
|
|
7727
|
+
"$ref": "#/definitions/singleCondition"
|
|
7697
7728
|
},
|
|
7698
7729
|
{
|
|
7699
|
-
"$ref": "#/definitions/
|
|
7730
|
+
"$ref": "#/definitions/compositeCondition"
|
|
7700
7731
|
}
|
|
7701
7732
|
]
|
|
7702
7733
|
},
|
|
@@ -7991,6 +8022,22 @@
|
|
|
7991
8022
|
"title": "Dialog Options",
|
|
7992
8023
|
"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"
|
|
7993
8024
|
},
|
|
8025
|
+
{
|
|
8026
|
+
"properties": {
|
|
8027
|
+
"key": {
|
|
8028
|
+
"maxLength": 100,
|
|
8029
|
+
"type": "string",
|
|
8030
|
+
"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"
|
|
8031
|
+
}
|
|
8032
|
+
},
|
|
8033
|
+
"required": [
|
|
8034
|
+
"key"
|
|
8035
|
+
],
|
|
8036
|
+
"shortClassName": "dialogModuleOptions",
|
|
8037
|
+
"type": "object",
|
|
8038
|
+
"title": "Dialog Module Options",
|
|
8039
|
+
"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"
|
|
8040
|
+
},
|
|
7994
8041
|
{
|
|
7995
8042
|
"properties": {
|
|
7996
8043
|
"offsetX": {
|
|
@@ -8037,22 +8084,6 @@
|
|
|
8037
8084
|
"type": "object",
|
|
8038
8085
|
"title": "Inline Dialog Options",
|
|
8039
8086
|
"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"
|
|
8056
8087
|
}
|
|
8057
8088
|
]
|
|
8058
8089
|
},
|
|
@@ -8406,10 +8437,10 @@
|
|
|
8406
8437
|
"type": "object",
|
|
8407
8438
|
"anyOf": [
|
|
8408
8439
|
{
|
|
8409
|
-
"$ref": "
|
|
8440
|
+
"$ref": "#"
|
|
8410
8441
|
},
|
|
8411
8442
|
{
|
|
8412
|
-
"$ref": "
|
|
8443
|
+
"$ref": "#/definitions/singleCondition"
|
|
8413
8444
|
}
|
|
8414
8445
|
]
|
|
8415
8446
|
},
|
|
@@ -8709,17 +8740,22 @@
|
|
|
8709
8740
|
"controls": {
|
|
8710
8741
|
"items": {
|
|
8711
8742
|
"properties": {
|
|
8743
|
+
"macroParameterValue": {
|
|
8744
|
+
"maxLength": 10000,
|
|
8745
|
+
"type": "string",
|
|
8746
|
+
"fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n"
|
|
8747
|
+
},
|
|
8712
8748
|
"label": {
|
|
8713
8749
|
"$ref": "#/definitions/i18nProperty",
|
|
8714
8750
|
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
8715
8751
|
},
|
|
8716
8752
|
"type": {
|
|
8717
8753
|
"enum": [
|
|
8718
|
-
"
|
|
8719
|
-
"
|
|
8754
|
+
"togglebutton",
|
|
8755
|
+
"TOGGLEBUTTON"
|
|
8720
8756
|
],
|
|
8721
8757
|
"type": "string",
|
|
8722
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
8758
|
+
"fieldDescription": "\n\nThe type field must be set to 'togglebutton'\n\n"
|
|
8723
8759
|
},
|
|
8724
8760
|
"key": {
|
|
8725
8761
|
"pattern": "^[a-zA-Z0-9-]+$",
|
|
@@ -8729,58 +8765,61 @@
|
|
|
8729
8765
|
}
|
|
8730
8766
|
},
|
|
8731
8767
|
"required": [
|
|
8768
|
+
"macroParameterValue",
|
|
8732
8769
|
"label",
|
|
8733
8770
|
"type",
|
|
8734
8771
|
"key"
|
|
8735
8772
|
],
|
|
8736
8773
|
"additionalProperties": true,
|
|
8737
|
-
"shortClassName": "
|
|
8774
|
+
"shortClassName": "macroToggleButtonControlBean",
|
|
8738
8775
|
"type": "object",
|
|
8739
|
-
"title": "
|
|
8740
|
-
"description": "\n\nDefines a button which
|
|
8776
|
+
"title": "ToggleButtonControl",
|
|
8777
|
+
"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"
|
|
8741
8778
|
},
|
|
8742
8779
|
"type": "array",
|
|
8743
|
-
"fieldDescription": "\n\
|
|
8780
|
+
"fieldDescription": "\n\nToggle buttons which will appear in the toggle group\n\n"
|
|
8781
|
+
},
|
|
8782
|
+
"macroParameter": {
|
|
8783
|
+
"pattern": "[-_a-z0-9\\.]+",
|
|
8784
|
+
"maxLength": 100,
|
|
8785
|
+
"type": "string",
|
|
8786
|
+
"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"
|
|
8744
8787
|
},
|
|
8745
8788
|
"type": {
|
|
8746
8789
|
"enum": [
|
|
8747
|
-
"
|
|
8748
|
-
"
|
|
8790
|
+
"togglegroup",
|
|
8791
|
+
"TOGGLEGROUP"
|
|
8749
8792
|
],
|
|
8750
8793
|
"type": "string",
|
|
8751
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
8794
|
+
"fieldDescription": "\n\nThe type field must be set to 'togglegroup'\n\n"
|
|
8752
8795
|
}
|
|
8753
8796
|
},
|
|
8754
8797
|
"required": [
|
|
8755
8798
|
"controls",
|
|
8799
|
+
"macroParameter",
|
|
8756
8800
|
"type"
|
|
8757
8801
|
],
|
|
8758
|
-
"shortClassName": "
|
|
8802
|
+
"shortClassName": "macroToggleGroupBean",
|
|
8759
8803
|
"type": "object",
|
|
8760
|
-
"title": "
|
|
8761
|
-
"description": "\n\nDefines a
|
|
8804
|
+
"title": "ToggleGroup",
|
|
8805
|
+
"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"
|
|
8762
8806
|
},
|
|
8763
8807
|
{
|
|
8764
8808
|
"properties": {
|
|
8765
8809
|
"controls": {
|
|
8766
8810
|
"items": {
|
|
8767
8811
|
"properties": {
|
|
8768
|
-
"macroParameterValue": {
|
|
8769
|
-
"maxLength": 10000,
|
|
8770
|
-
"type": "string",
|
|
8771
|
-
"fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n"
|
|
8772
|
-
},
|
|
8773
8812
|
"label": {
|
|
8774
8813
|
"$ref": "#/definitions/i18nProperty",
|
|
8775
8814
|
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
8776
8815
|
},
|
|
8777
8816
|
"type": {
|
|
8778
8817
|
"enum": [
|
|
8779
|
-
"
|
|
8780
|
-
"
|
|
8818
|
+
"button",
|
|
8819
|
+
"BUTTON"
|
|
8781
8820
|
],
|
|
8782
8821
|
"type": "string",
|
|
8783
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
8822
|
+
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
8784
8823
|
},
|
|
8785
8824
|
"key": {
|
|
8786
8825
|
"pattern": "^[a-zA-Z0-9-]+$",
|
|
@@ -8790,44 +8829,36 @@
|
|
|
8790
8829
|
}
|
|
8791
8830
|
},
|
|
8792
8831
|
"required": [
|
|
8793
|
-
"macroParameterValue",
|
|
8794
8832
|
"label",
|
|
8795
8833
|
"type",
|
|
8796
8834
|
"key"
|
|
8797
8835
|
],
|
|
8798
8836
|
"additionalProperties": true,
|
|
8799
|
-
"shortClassName": "
|
|
8837
|
+
"shortClassName": "buttonControlBean",
|
|
8800
8838
|
"type": "object",
|
|
8801
|
-
"title": "
|
|
8802
|
-
"description": "\n\nDefines a
|
|
8839
|
+
"title": "ButtonControl",
|
|
8840
|
+
"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"
|
|
8803
8841
|
},
|
|
8804
8842
|
"type": "array",
|
|
8805
|
-
"fieldDescription": "\n\
|
|
8806
|
-
},
|
|
8807
|
-
"macroParameter": {
|
|
8808
|
-
"pattern": "[-_a-z0-9\\.]+",
|
|
8809
|
-
"maxLength": 100,
|
|
8810
|
-
"type": "string",
|
|
8811
|
-
"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"
|
|
8843
|
+
"fieldDescription": "\n\nControls which will appear in the control group\n\n"
|
|
8812
8844
|
},
|
|
8813
8845
|
"type": {
|
|
8814
8846
|
"enum": [
|
|
8815
|
-
"
|
|
8816
|
-
"
|
|
8847
|
+
"group",
|
|
8848
|
+
"GROUP"
|
|
8817
8849
|
],
|
|
8818
8850
|
"type": "string",
|
|
8819
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
8851
|
+
"fieldDescription": "\n\nThe type field must be set to 'group'\n\n"
|
|
8820
8852
|
}
|
|
8821
8853
|
},
|
|
8822
8854
|
"required": [
|
|
8823
8855
|
"controls",
|
|
8824
|
-
"macroParameter",
|
|
8825
8856
|
"type"
|
|
8826
8857
|
],
|
|
8827
|
-
"shortClassName": "
|
|
8858
|
+
"shortClassName": "controlGroupBean",
|
|
8828
8859
|
"type": "object",
|
|
8829
|
-
"title": "
|
|
8830
|
-
"description": "\n\nDefines a
|
|
8860
|
+
"title": "ControlGroup",
|
|
8861
|
+
"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"
|
|
8831
8862
|
},
|
|
8832
8863
|
{
|
|
8833
8864
|
"properties": {
|
|
@@ -9188,72 +9219,35 @@
|
|
|
9188
9219
|
"anyOf": [
|
|
9189
9220
|
{
|
|
9190
9221
|
"properties": {
|
|
9191
|
-
"controls": {
|
|
9192
|
-
"items": {
|
|
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
|
-
},
|
|
9199
|
-
"label": {
|
|
9200
|
-
"$ref": "#/definitions/i18nProperty",
|
|
9201
|
-
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
9202
|
-
},
|
|
9203
|
-
"type": {
|
|
9204
|
-
"enum": [
|
|
9205
|
-
"togglebutton",
|
|
9206
|
-
"TOGGLEBUTTON"
|
|
9207
|
-
],
|
|
9208
|
-
"type": "string",
|
|
9209
|
-
"fieldDescription": "\n\nThe type field must be set to 'togglebutton'\n\n"
|
|
9210
|
-
},
|
|
9211
|
-
"key": {
|
|
9212
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
9213
|
-
"maxLength": 100,
|
|
9214
|
-
"type": "string",
|
|
9215
|
-
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
9216
|
-
}
|
|
9217
|
-
},
|
|
9218
|
-
"required": [
|
|
9219
|
-
"macroParameterValue",
|
|
9220
|
-
"label",
|
|
9221
|
-
"type",
|
|
9222
|
-
"key"
|
|
9223
|
-
],
|
|
9224
|
-
"additionalProperties": true,
|
|
9225
|
-
"shortClassName": "macroToggleButtonControlBean",
|
|
9226
|
-
"type": "object",
|
|
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"
|
|
9229
|
-
},
|
|
9230
|
-
"type": "array",
|
|
9231
|
-
"fieldDescription": "\n\nToggle buttons which will appear in the toggle group\n\n"
|
|
9232
|
-
},
|
|
9233
9222
|
"macroParameter": {
|
|
9234
|
-
"pattern": "[-_a-z0-9\\.]+",
|
|
9235
9223
|
"maxLength": 100,
|
|
9236
9224
|
"type": "string",
|
|
9237
|
-
"fieldDescription": "\n\nThe
|
|
9225
|
+
"fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
|
|
9238
9226
|
},
|
|
9239
9227
|
"type": {
|
|
9240
9228
|
"enum": [
|
|
9241
|
-
"
|
|
9242
|
-
"
|
|
9229
|
+
"text",
|
|
9230
|
+
"TEXT"
|
|
9243
9231
|
],
|
|
9244
9232
|
"type": "string",
|
|
9245
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
9233
|
+
"fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
|
|
9234
|
+
},
|
|
9235
|
+
"key": {
|
|
9236
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
9237
|
+
"maxLength": 100,
|
|
9238
|
+
"type": "string",
|
|
9239
|
+
"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"
|
|
9246
9240
|
}
|
|
9247
9241
|
},
|
|
9248
9242
|
"required": [
|
|
9249
|
-
"controls",
|
|
9250
9243
|
"macroParameter",
|
|
9251
|
-
"type"
|
|
9244
|
+
"type",
|
|
9245
|
+
"key"
|
|
9252
9246
|
],
|
|
9253
|
-
"shortClassName": "
|
|
9247
|
+
"shortClassName": "textControlBean",
|
|
9254
9248
|
"type": "object",
|
|
9255
|
-
"title": "
|
|
9256
|
-
"description": "\n\nDefines a
|
|
9249
|
+
"title": "TextControl",
|
|
9250
|
+
"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"
|
|
9257
9251
|
},
|
|
9258
9252
|
{
|
|
9259
9253
|
"properties": {
|
|
@@ -9345,35 +9339,72 @@
|
|
|
9345
9339
|
},
|
|
9346
9340
|
{
|
|
9347
9341
|
"properties": {
|
|
9342
|
+
"controls": {
|
|
9343
|
+
"items": {
|
|
9344
|
+
"properties": {
|
|
9345
|
+
"macroParameterValue": {
|
|
9346
|
+
"maxLength": 10000,
|
|
9347
|
+
"type": "string",
|
|
9348
|
+
"fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n"
|
|
9349
|
+
},
|
|
9350
|
+
"label": {
|
|
9351
|
+
"$ref": "#/definitions/i18nProperty",
|
|
9352
|
+
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
9353
|
+
},
|
|
9354
|
+
"type": {
|
|
9355
|
+
"enum": [
|
|
9356
|
+
"togglebutton",
|
|
9357
|
+
"TOGGLEBUTTON"
|
|
9358
|
+
],
|
|
9359
|
+
"type": "string",
|
|
9360
|
+
"fieldDescription": "\n\nThe type field must be set to 'togglebutton'\n\n"
|
|
9361
|
+
},
|
|
9362
|
+
"key": {
|
|
9363
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
9364
|
+
"maxLength": 100,
|
|
9365
|
+
"type": "string",
|
|
9366
|
+
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
9367
|
+
}
|
|
9368
|
+
},
|
|
9369
|
+
"required": [
|
|
9370
|
+
"macroParameterValue",
|
|
9371
|
+
"label",
|
|
9372
|
+
"type",
|
|
9373
|
+
"key"
|
|
9374
|
+
],
|
|
9375
|
+
"additionalProperties": true,
|
|
9376
|
+
"shortClassName": "macroToggleButtonControlBean",
|
|
9377
|
+
"type": "object",
|
|
9378
|
+
"title": "ToggleButtonControl",
|
|
9379
|
+
"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"
|
|
9380
|
+
},
|
|
9381
|
+
"type": "array",
|
|
9382
|
+
"fieldDescription": "\n\nToggle buttons which will appear in the toggle group\n\n"
|
|
9383
|
+
},
|
|
9348
9384
|
"macroParameter": {
|
|
9385
|
+
"pattern": "[-_a-z0-9\\.]+",
|
|
9349
9386
|
"maxLength": 100,
|
|
9350
9387
|
"type": "string",
|
|
9351
|
-
"fieldDescription": "\n\nThe
|
|
9388
|
+
"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"
|
|
9352
9389
|
},
|
|
9353
9390
|
"type": {
|
|
9354
9391
|
"enum": [
|
|
9355
|
-
"
|
|
9356
|
-
"
|
|
9392
|
+
"togglegroup",
|
|
9393
|
+
"TOGGLEGROUP"
|
|
9357
9394
|
],
|
|
9358
9395
|
"type": "string",
|
|
9359
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
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"
|
|
9396
|
+
"fieldDescription": "\n\nThe type field must be set to 'togglegroup'\n\n"
|
|
9366
9397
|
}
|
|
9367
9398
|
},
|
|
9368
9399
|
"required": [
|
|
9400
|
+
"controls",
|
|
9369
9401
|
"macroParameter",
|
|
9370
|
-
"type"
|
|
9371
|
-
"key"
|
|
9402
|
+
"type"
|
|
9372
9403
|
],
|
|
9373
|
-
"shortClassName": "
|
|
9404
|
+
"shortClassName": "macroToggleGroupBean",
|
|
9374
9405
|
"type": "object",
|
|
9375
|
-
"title": "
|
|
9376
|
-
"description": "\n\nDefines a
|
|
9406
|
+
"title": "ToggleGroup",
|
|
9407
|
+
"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"
|
|
9377
9408
|
}
|
|
9378
9409
|
]
|
|
9379
9410
|
},
|
|
@@ -9576,10 +9607,10 @@
|
|
|
9576
9607
|
"type": "object",
|
|
9577
9608
|
"anyOf": [
|
|
9578
9609
|
{
|
|
9579
|
-
"$ref": "#/definitions/
|
|
9610
|
+
"$ref": "#/definitions/singleCondition"
|
|
9580
9611
|
},
|
|
9581
9612
|
{
|
|
9582
|
-
"$ref": "#/definitions/
|
|
9613
|
+
"$ref": "#/definitions/compositeCondition"
|
|
9583
9614
|
}
|
|
9584
9615
|
]
|
|
9585
9616
|
},
|
|
@@ -9609,6 +9640,51 @@
|
|
|
9609
9640
|
"type": "object",
|
|
9610
9641
|
"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",
|
|
9611
9642
|
"anyOf": [
|
|
9643
|
+
{
|
|
9644
|
+
"properties": {
|
|
9645
|
+
"size": {
|
|
9646
|
+
"enum": [
|
|
9647
|
+
"small",
|
|
9648
|
+
"SMALL",
|
|
9649
|
+
"medium",
|
|
9650
|
+
"MEDIUM",
|
|
9651
|
+
"large",
|
|
9652
|
+
"LARGE",
|
|
9653
|
+
"x-large",
|
|
9654
|
+
"X-LARGE",
|
|
9655
|
+
"fullscreen",
|
|
9656
|
+
"FULLSCREEN",
|
|
9657
|
+
"maximum",
|
|
9658
|
+
"MAXIMUM"
|
|
9659
|
+
],
|
|
9660
|
+
"type": "string",
|
|
9661
|
+
"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"
|
|
9662
|
+
},
|
|
9663
|
+
"chrome": {
|
|
9664
|
+
"type": "boolean",
|
|
9665
|
+
"fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
|
|
9666
|
+
"defaultValue": "true"
|
|
9667
|
+
},
|
|
9668
|
+
"width": {
|
|
9669
|
+
"maxLength": 10,
|
|
9670
|
+
"type": "string",
|
|
9671
|
+
"fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
|
|
9672
|
+
},
|
|
9673
|
+
"header": {
|
|
9674
|
+
"$ref": "#/definitions/i18nProperty",
|
|
9675
|
+
"fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
|
|
9676
|
+
},
|
|
9677
|
+
"height": {
|
|
9678
|
+
"maxLength": 10,
|
|
9679
|
+
"type": "string",
|
|
9680
|
+
"fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
|
|
9681
|
+
}
|
|
9682
|
+
},
|
|
9683
|
+
"shortClassName": "dialogOptions",
|
|
9684
|
+
"type": "object",
|
|
9685
|
+
"title": "Dialog Options",
|
|
9686
|
+
"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"
|
|
9687
|
+
},
|
|
9612
9688
|
{
|
|
9613
9689
|
"properties": {
|
|
9614
9690
|
"offsetX": {
|
|
@@ -9671,51 +9747,6 @@
|
|
|
9671
9747
|
"type": "object",
|
|
9672
9748
|
"title": "Dialog Module Options",
|
|
9673
9749
|
"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"
|
|
9674
|
-
},
|
|
9675
|
-
{
|
|
9676
|
-
"properties": {
|
|
9677
|
-
"size": {
|
|
9678
|
-
"enum": [
|
|
9679
|
-
"small",
|
|
9680
|
-
"SMALL",
|
|
9681
|
-
"medium",
|
|
9682
|
-
"MEDIUM",
|
|
9683
|
-
"large",
|
|
9684
|
-
"LARGE",
|
|
9685
|
-
"x-large",
|
|
9686
|
-
"X-LARGE",
|
|
9687
|
-
"fullscreen",
|
|
9688
|
-
"FULLSCREEN",
|
|
9689
|
-
"maximum",
|
|
9690
|
-
"MAXIMUM"
|
|
9691
|
-
],
|
|
9692
|
-
"type": "string",
|
|
9693
|
-
"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"
|
|
9694
|
-
},
|
|
9695
|
-
"chrome": {
|
|
9696
|
-
"type": "boolean",
|
|
9697
|
-
"fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
|
|
9698
|
-
"defaultValue": "true"
|
|
9699
|
-
},
|
|
9700
|
-
"width": {
|
|
9701
|
-
"maxLength": 10,
|
|
9702
|
-
"type": "string",
|
|
9703
|
-
"fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
|
|
9704
|
-
},
|
|
9705
|
-
"header": {
|
|
9706
|
-
"$ref": "#/definitions/i18nProperty",
|
|
9707
|
-
"fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
|
|
9708
|
-
},
|
|
9709
|
-
"height": {
|
|
9710
|
-
"maxLength": 10,
|
|
9711
|
-
"type": "string",
|
|
9712
|
-
"fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
|
|
9713
|
-
}
|
|
9714
|
-
},
|
|
9715
|
-
"shortClassName": "dialogOptions",
|
|
9716
|
-
"type": "object",
|
|
9717
|
-
"title": "Dialog Options",
|
|
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"
|
|
9719
9750
|
}
|
|
9720
9751
|
]
|
|
9721
9752
|
},
|
|
@@ -11040,33 +11071,6 @@
|
|
|
11040
11071
|
"title": "Icon",
|
|
11041
11072
|
"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"
|
|
11042
11073
|
},
|
|
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
|
-
},
|
|
11070
11074
|
"compositeCondition": {
|
|
11071
11075
|
"properties": {
|
|
11072
11076
|
"conditions": {
|
|
@@ -11074,10 +11078,10 @@
|
|
|
11074
11078
|
"type": "object",
|
|
11075
11079
|
"anyOf": [
|
|
11076
11080
|
{
|
|
11077
|
-
"$ref": "
|
|
11081
|
+
"$ref": "#"
|
|
11078
11082
|
},
|
|
11079
11083
|
{
|
|
11080
|
-
"$ref": "
|
|
11084
|
+
"$ref": "#/definitions/singleCondition"
|
|
11081
11085
|
}
|
|
11082
11086
|
]
|
|
11083
11087
|
},
|
|
@@ -11100,6 +11104,33 @@
|
|
|
11100
11104
|
"title": "Composite Condition",
|
|
11101
11105
|
"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"
|
|
11102
11106
|
},
|
|
11107
|
+
"singleCondition": {
|
|
11108
|
+
"properties": {
|
|
11109
|
+
"condition": {
|
|
11110
|
+
"maxLength": 100,
|
|
11111
|
+
"type": "string",
|
|
11112
|
+
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
11113
|
+
},
|
|
11114
|
+
"invert": {
|
|
11115
|
+
"type": "boolean",
|
|
11116
|
+
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
11117
|
+
"defaultValue": "false"
|
|
11118
|
+
},
|
|
11119
|
+
"params": {
|
|
11120
|
+
"additionalProperties": true,
|
|
11121
|
+
"type": "object",
|
|
11122
|
+
"fieldTitle": "Object",
|
|
11123
|
+
"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"
|
|
11124
|
+
}
|
|
11125
|
+
},
|
|
11126
|
+
"required": [
|
|
11127
|
+
"condition"
|
|
11128
|
+
],
|
|
11129
|
+
"shortClassName": "singleConditionBean",
|
|
11130
|
+
"type": "object",
|
|
11131
|
+
"title": "Single Condition",
|
|
11132
|
+
"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"
|
|
11133
|
+
},
|
|
11103
11134
|
"webPanelLayout": {
|
|
11104
11135
|
"properties": {
|
|
11105
11136
|
"width": {
|