@forge/manifest 3.4.0-next.5 → 3.4.0-next.8
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 +371 -340
- package/out/schema/manifest.d.ts +383 -367
- 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": {
|
|
@@ -5368,10 +5399,10 @@
|
|
|
5368
5399
|
"type": "object",
|
|
5369
5400
|
"anyOf": [
|
|
5370
5401
|
{
|
|
5371
|
-
"$ref": "#/definitions/
|
|
5402
|
+
"$ref": "#/definitions/singleCondition"
|
|
5372
5403
|
},
|
|
5373
5404
|
{
|
|
5374
|
-
"$ref": "#/definitions/
|
|
5405
|
+
"$ref": "#/definitions/compositeCondition"
|
|
5375
5406
|
}
|
|
5376
5407
|
]
|
|
5377
5408
|
},
|
|
@@ -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
|
},
|
|
@@ -5668,6 +5699,22 @@
|
|
|
5668
5699
|
"title": "Inline Dialog Options",
|
|
5669
5700
|
"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"
|
|
5670
5701
|
},
|
|
5702
|
+
{
|
|
5703
|
+
"properties": {
|
|
5704
|
+
"key": {
|
|
5705
|
+
"maxLength": 100,
|
|
5706
|
+
"type": "string",
|
|
5707
|
+
"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"
|
|
5708
|
+
}
|
|
5709
|
+
},
|
|
5710
|
+
"required": [
|
|
5711
|
+
"key"
|
|
5712
|
+
],
|
|
5713
|
+
"shortClassName": "dialogModuleOptions",
|
|
5714
|
+
"type": "object",
|
|
5715
|
+
"title": "Dialog Module Options",
|
|
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
|
+
},
|
|
5671
5718
|
{
|
|
5672
5719
|
"properties": {
|
|
5673
5720
|
"size": {
|
|
@@ -5712,22 +5759,6 @@
|
|
|
5712
5759
|
"type": "object",
|
|
5713
5760
|
"title": "Dialog Options",
|
|
5714
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"
|
|
5715
|
-
},
|
|
5716
|
-
{
|
|
5717
|
-
"properties": {
|
|
5718
|
-
"key": {
|
|
5719
|
-
"maxLength": 100,
|
|
5720
|
-
"type": "string",
|
|
5721
|
-
"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"
|
|
5722
|
-
}
|
|
5723
|
-
},
|
|
5724
|
-
"required": [
|
|
5725
|
-
"key"
|
|
5726
|
-
],
|
|
5727
|
-
"shortClassName": "dialogModuleOptions",
|
|
5728
|
-
"type": "object",
|
|
5729
|
-
"title": "Dialog Module Options",
|
|
5730
|
-
"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"
|
|
5731
5762
|
}
|
|
5732
5763
|
]
|
|
5733
5764
|
},
|
|
@@ -5791,10 +5822,10 @@
|
|
|
5791
5822
|
"type": "object",
|
|
5792
5823
|
"anyOf": [
|
|
5793
5824
|
{
|
|
5794
|
-
"$ref": "
|
|
5825
|
+
"$ref": "#"
|
|
5795
5826
|
},
|
|
5796
5827
|
{
|
|
5797
|
-
"$ref": "
|
|
5828
|
+
"$ref": "#/definitions/singleCondition"
|
|
5798
5829
|
}
|
|
5799
5830
|
]
|
|
5800
5831
|
},
|
|
@@ -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
|
},
|
|
@@ -7567,10 +7598,10 @@
|
|
|
7567
7598
|
"type": "object",
|
|
7568
7599
|
"anyOf": [
|
|
7569
7600
|
{
|
|
7570
|
-
"$ref": "#/definitions/
|
|
7601
|
+
"$ref": "#/definitions/compositeCondition"
|
|
7571
7602
|
},
|
|
7572
7603
|
{
|
|
7573
|
-
"$ref": "#/definitions/
|
|
7604
|
+
"$ref": "#/definitions/singleCondition"
|
|
7574
7605
|
}
|
|
7575
7606
|
]
|
|
7576
7607
|
},
|
|
@@ -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
|
},
|
|
@@ -7757,10 +7788,10 @@
|
|
|
7757
7788
|
"type": "object",
|
|
7758
7789
|
"anyOf": [
|
|
7759
7790
|
{
|
|
7760
|
-
"$ref": "#/definitions/
|
|
7791
|
+
"$ref": "#/definitions/singleCondition"
|
|
7761
7792
|
},
|
|
7762
7793
|
{
|
|
7763
|
-
"$ref": "#/definitions/
|
|
7794
|
+
"$ref": "#/definitions/compositeCondition"
|
|
7764
7795
|
}
|
|
7765
7796
|
]
|
|
7766
7797
|
},
|
|
@@ -7815,10 +7846,10 @@
|
|
|
7815
7846
|
"type": "object",
|
|
7816
7847
|
"anyOf": [
|
|
7817
7848
|
{
|
|
7818
|
-
"$ref": "#/definitions/
|
|
7849
|
+
"$ref": "#/definitions/singleCondition"
|
|
7819
7850
|
},
|
|
7820
7851
|
{
|
|
7821
|
-
"$ref": "#/definitions/
|
|
7852
|
+
"$ref": "#/definitions/compositeCondition"
|
|
7822
7853
|
}
|
|
7823
7854
|
]
|
|
7824
7855
|
},
|
|
@@ -7873,10 +7904,10 @@
|
|
|
7873
7904
|
"type": "object",
|
|
7874
7905
|
"anyOf": [
|
|
7875
7906
|
{
|
|
7876
|
-
"$ref": "#/definitions/
|
|
7907
|
+
"$ref": "#/definitions/singleCondition"
|
|
7877
7908
|
},
|
|
7878
7909
|
{
|
|
7879
|
-
"$ref": "#/definitions/
|
|
7910
|
+
"$ref": "#/definitions/compositeCondition"
|
|
7880
7911
|
}
|
|
7881
7912
|
]
|
|
7882
7913
|
},
|
|
@@ -8109,33 +8140,6 @@
|
|
|
8109
8140
|
"items": {
|
|
8110
8141
|
"type": "object",
|
|
8111
8142
|
"anyOf": [
|
|
8112
|
-
{
|
|
8113
|
-
"properties": {
|
|
8114
|
-
"condition": {
|
|
8115
|
-
"maxLength": 100,
|
|
8116
|
-
"type": "string",
|
|
8117
|
-
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
8118
|
-
},
|
|
8119
|
-
"invert": {
|
|
8120
|
-
"type": "boolean",
|
|
8121
|
-
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
8122
|
-
"defaultValue": "false"
|
|
8123
|
-
},
|
|
8124
|
-
"params": {
|
|
8125
|
-
"additionalProperties": true,
|
|
8126
|
-
"type": "object",
|
|
8127
|
-
"fieldTitle": "Object",
|
|
8128
|
-
"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"
|
|
8129
|
-
}
|
|
8130
|
-
},
|
|
8131
|
-
"required": [
|
|
8132
|
-
"condition"
|
|
8133
|
-
],
|
|
8134
|
-
"shortClassName": "singleConditionBean",
|
|
8135
|
-
"type": "object",
|
|
8136
|
-
"title": "Single Condition",
|
|
8137
|
-
"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"
|
|
8138
|
-
},
|
|
8139
8143
|
{
|
|
8140
8144
|
"properties": {
|
|
8141
8145
|
"conditions": {
|
|
@@ -8143,10 +8147,10 @@
|
|
|
8143
8147
|
"type": "object",
|
|
8144
8148
|
"anyOf": [
|
|
8145
8149
|
{
|
|
8146
|
-
"$ref": "
|
|
8150
|
+
"$ref": "#/definitions/singleCondition"
|
|
8147
8151
|
},
|
|
8148
8152
|
{
|
|
8149
|
-
"$ref": "
|
|
8153
|
+
"$ref": "#"
|
|
8150
8154
|
}
|
|
8151
8155
|
]
|
|
8152
8156
|
},
|
|
@@ -8168,6 +8172,33 @@
|
|
|
8168
8172
|
"type": "object",
|
|
8169
8173
|
"title": "Composite Condition",
|
|
8170
8174
|
"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"
|
|
8175
|
+
},
|
|
8176
|
+
{
|
|
8177
|
+
"properties": {
|
|
8178
|
+
"condition": {
|
|
8179
|
+
"maxLength": 100,
|
|
8180
|
+
"type": "string",
|
|
8181
|
+
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
8182
|
+
},
|
|
8183
|
+
"invert": {
|
|
8184
|
+
"type": "boolean",
|
|
8185
|
+
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
8186
|
+
"defaultValue": "false"
|
|
8187
|
+
},
|
|
8188
|
+
"params": {
|
|
8189
|
+
"additionalProperties": true,
|
|
8190
|
+
"type": "object",
|
|
8191
|
+
"fieldTitle": "Object",
|
|
8192
|
+
"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"
|
|
8193
|
+
}
|
|
8194
|
+
},
|
|
8195
|
+
"required": [
|
|
8196
|
+
"condition"
|
|
8197
|
+
],
|
|
8198
|
+
"shortClassName": "singleConditionBean",
|
|
8199
|
+
"type": "object",
|
|
8200
|
+
"title": "Single Condition",
|
|
8201
|
+
"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"
|
|
8171
8202
|
}
|
|
8172
8203
|
]
|
|
8173
8204
|
},
|
|
@@ -8221,10 +8252,10 @@
|
|
|
8221
8252
|
"type": "object",
|
|
8222
8253
|
"anyOf": [
|
|
8223
8254
|
{
|
|
8224
|
-
"$ref": "#/definitions/
|
|
8255
|
+
"$ref": "#/definitions/compositeCondition"
|
|
8225
8256
|
},
|
|
8226
8257
|
{
|
|
8227
|
-
"$ref": "#/definitions/
|
|
8258
|
+
"$ref": "#/definitions/singleCondition"
|
|
8228
8259
|
}
|
|
8229
8260
|
]
|
|
8230
8261
|
},
|
|
@@ -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
|
},
|
|
@@ -8704,6 +8735,38 @@
|
|
|
8704
8735
|
"items": {
|
|
8705
8736
|
"type": "object",
|
|
8706
8737
|
"anyOf": [
|
|
8738
|
+
{
|
|
8739
|
+
"properties": {
|
|
8740
|
+
"macroParameter": {
|
|
8741
|
+
"maxLength": 100,
|
|
8742
|
+
"type": "string",
|
|
8743
|
+
"fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
|
|
8744
|
+
},
|
|
8745
|
+
"type": {
|
|
8746
|
+
"enum": [
|
|
8747
|
+
"text",
|
|
8748
|
+
"TEXT"
|
|
8749
|
+
],
|
|
8750
|
+
"type": "string",
|
|
8751
|
+
"fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
|
|
8752
|
+
},
|
|
8753
|
+
"key": {
|
|
8754
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
8755
|
+
"maxLength": 100,
|
|
8756
|
+
"type": "string",
|
|
8757
|
+
"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"
|
|
8758
|
+
}
|
|
8759
|
+
},
|
|
8760
|
+
"required": [
|
|
8761
|
+
"macroParameter",
|
|
8762
|
+
"type",
|
|
8763
|
+
"key"
|
|
8764
|
+
],
|
|
8765
|
+
"shortClassName": "textControlBean",
|
|
8766
|
+
"type": "object",
|
|
8767
|
+
"title": "TextControl",
|
|
8768
|
+
"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"
|
|
8769
|
+
},
|
|
8707
8770
|
{
|
|
8708
8771
|
"properties": {
|
|
8709
8772
|
"controls": {
|
|
@@ -8760,6 +8823,38 @@
|
|
|
8760
8823
|
"title": "ControlGroup",
|
|
8761
8824
|
"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"
|
|
8762
8825
|
},
|
|
8826
|
+
{
|
|
8827
|
+
"properties": {
|
|
8828
|
+
"label": {
|
|
8829
|
+
"$ref": "#/definitions/i18nProperty",
|
|
8830
|
+
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
8831
|
+
},
|
|
8832
|
+
"type": {
|
|
8833
|
+
"enum": [
|
|
8834
|
+
"button",
|
|
8835
|
+
"BUTTON"
|
|
8836
|
+
],
|
|
8837
|
+
"type": "string",
|
|
8838
|
+
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
8839
|
+
},
|
|
8840
|
+
"key": {
|
|
8841
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
8842
|
+
"maxLength": 100,
|
|
8843
|
+
"type": "string",
|
|
8844
|
+
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
8845
|
+
}
|
|
8846
|
+
},
|
|
8847
|
+
"required": [
|
|
8848
|
+
"label",
|
|
8849
|
+
"type",
|
|
8850
|
+
"key"
|
|
8851
|
+
],
|
|
8852
|
+
"additionalProperties": true,
|
|
8853
|
+
"shortClassName": "buttonControlBean",
|
|
8854
|
+
"type": "object",
|
|
8855
|
+
"title": "ButtonControl",
|
|
8856
|
+
"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"
|
|
8857
|
+
},
|
|
8763
8858
|
{
|
|
8764
8859
|
"properties": {
|
|
8765
8860
|
"controls": {
|
|
@@ -8828,70 +8923,6 @@
|
|
|
8828
8923
|
"type": "object",
|
|
8829
8924
|
"title": "ToggleGroup",
|
|
8830
8925
|
"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"
|
|
8895
8926
|
}
|
|
8896
8927
|
]
|
|
8897
8928
|
},
|
|
@@ -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,53 +9640,6 @@
|
|
|
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": [
|
|
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
|
-
},
|
|
9659
9643
|
{
|
|
9660
9644
|
"properties": {
|
|
9661
9645
|
"key": {
|
|
@@ -9716,6 +9700,53 @@
|
|
|
9716
9700
|
"type": "object",
|
|
9717
9701
|
"title": "Dialog Options",
|
|
9718
9702
|
"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"
|
|
9703
|
+
},
|
|
9704
|
+
{
|
|
9705
|
+
"properties": {
|
|
9706
|
+
"offsetX": {
|
|
9707
|
+
"maxLength": 10,
|
|
9708
|
+
"type": "string",
|
|
9709
|
+
"fieldDescription": "\n\nSets an offset distance of the inline-dialog from the trigger element along the x-axis in pixels\n\n"
|
|
9710
|
+
},
|
|
9711
|
+
"offsetY": {
|
|
9712
|
+
"maxLength": 10,
|
|
9713
|
+
"type": "string",
|
|
9714
|
+
"fieldDescription": "\n\nSets an offset distance of the inline-dialog from the trigger element along the y-axis in pixels\n\n"
|
|
9715
|
+
},
|
|
9716
|
+
"width": {
|
|
9717
|
+
"maxLength": 10,
|
|
9718
|
+
"type": "string",
|
|
9719
|
+
"fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
|
|
9720
|
+
},
|
|
9721
|
+
"onTop": {
|
|
9722
|
+
"type": "boolean",
|
|
9723
|
+
"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"
|
|
9724
|
+
},
|
|
9725
|
+
"showDelay": {
|
|
9726
|
+
"type": "integer",
|
|
9727
|
+
"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"
|
|
9728
|
+
},
|
|
9729
|
+
"closeOthers": {
|
|
9730
|
+
"type": "boolean",
|
|
9731
|
+
"fieldDescription": "\n\nDetermines if all other dialogs on the screen are closed when this one is opened\n\n"
|
|
9732
|
+
},
|
|
9733
|
+
"persistent": {
|
|
9734
|
+
"type": "boolean",
|
|
9735
|
+
"fieldDescription": "\n\nThis option, ignores the 'closeOthers' option\n\n"
|
|
9736
|
+
},
|
|
9737
|
+
"onHover": {
|
|
9738
|
+
"type": "boolean",
|
|
9739
|
+
"fieldDescription": "\n\nDetermines whether the inline-Dialog will show on a mouseOver or mouseClick of the trigger\n\n"
|
|
9740
|
+
},
|
|
9741
|
+
"isRelativeToMouse": {
|
|
9742
|
+
"type": "boolean",
|
|
9743
|
+
"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"
|
|
9744
|
+
}
|
|
9745
|
+
},
|
|
9746
|
+
"shortClassName": "inlineDialogOptions",
|
|
9747
|
+
"type": "object",
|
|
9748
|
+
"title": "Inline Dialog Options",
|
|
9749
|
+
"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"
|
|
9719
9750
|
}
|
|
9720
9751
|
]
|
|
9721
9752
|
},
|
|
@@ -11047,10 +11078,10 @@
|
|
|
11047
11078
|
"type": "object",
|
|
11048
11079
|
"anyOf": [
|
|
11049
11080
|
{
|
|
11050
|
-
"$ref": "
|
|
11081
|
+
"$ref": "#"
|
|
11051
11082
|
},
|
|
11052
11083
|
{
|
|
11053
|
-
"$ref": "
|
|
11084
|
+
"$ref": "#/definitions/singleCondition"
|
|
11054
11085
|
}
|
|
11055
11086
|
]
|
|
11056
11087
|
},
|