@forge/manifest 3.1.0-next.6 → 3.1.0
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 +44 -0
- package/out/mapping/product-event-to-scope-mapping.json +0 -11
- package/out/schema/manifest-schema.json +251 -251
- package/out/schema/manifest.d.ts +246 -246
- package/package.json +3 -3
|
@@ -6276,10 +6276,10 @@
|
|
|
6276
6276
|
"type": "object",
|
|
6277
6277
|
"anyOf": [
|
|
6278
6278
|
{
|
|
6279
|
-
"$ref": "#/definitions/
|
|
6279
|
+
"$ref": "#/definitions/singleCondition"
|
|
6280
6280
|
},
|
|
6281
6281
|
{
|
|
6282
|
-
"$ref": "#/definitions/
|
|
6282
|
+
"$ref": "#/definitions/compositeCondition"
|
|
6283
6283
|
}
|
|
6284
6284
|
]
|
|
6285
6285
|
},
|
|
@@ -6584,6 +6584,22 @@
|
|
|
6584
6584
|
"type": "object",
|
|
6585
6585
|
"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",
|
|
6586
6586
|
"anyOf": [
|
|
6587
|
+
{
|
|
6588
|
+
"properties": {
|
|
6589
|
+
"key": {
|
|
6590
|
+
"maxLength": 100,
|
|
6591
|
+
"type": "string",
|
|
6592
|
+
"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"
|
|
6593
|
+
}
|
|
6594
|
+
},
|
|
6595
|
+
"required": [
|
|
6596
|
+
"key"
|
|
6597
|
+
],
|
|
6598
|
+
"shortClassName": "dialogModuleOptions",
|
|
6599
|
+
"type": "object",
|
|
6600
|
+
"title": "Dialog Module Options",
|
|
6601
|
+
"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"
|
|
6602
|
+
},
|
|
6587
6603
|
{
|
|
6588
6604
|
"properties": {
|
|
6589
6605
|
"size": {
|
|
@@ -6675,22 +6691,6 @@
|
|
|
6675
6691
|
"type": "object",
|
|
6676
6692
|
"title": "Inline Dialog Options",
|
|
6677
6693
|
"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"
|
|
6678
|
-
},
|
|
6679
|
-
{
|
|
6680
|
-
"properties": {
|
|
6681
|
-
"key": {
|
|
6682
|
-
"maxLength": 100,
|
|
6683
|
-
"type": "string",
|
|
6684
|
-
"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"
|
|
6685
|
-
}
|
|
6686
|
-
},
|
|
6687
|
-
"required": [
|
|
6688
|
-
"key"
|
|
6689
|
-
],
|
|
6690
|
-
"shortClassName": "dialogModuleOptions",
|
|
6691
|
-
"type": "object",
|
|
6692
|
-
"title": "Dialog Module Options",
|
|
6693
|
-
"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"
|
|
6694
6694
|
}
|
|
6695
6695
|
]
|
|
6696
6696
|
},
|
|
@@ -6747,33 +6747,6 @@
|
|
|
6747
6747
|
"items": {
|
|
6748
6748
|
"type": "object",
|
|
6749
6749
|
"anyOf": [
|
|
6750
|
-
{
|
|
6751
|
-
"properties": {
|
|
6752
|
-
"condition": {
|
|
6753
|
-
"maxLength": 100,
|
|
6754
|
-
"type": "string",
|
|
6755
|
-
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
6756
|
-
},
|
|
6757
|
-
"invert": {
|
|
6758
|
-
"type": "boolean",
|
|
6759
|
-
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
6760
|
-
"defaultValue": "false"
|
|
6761
|
-
},
|
|
6762
|
-
"params": {
|
|
6763
|
-
"additionalProperties": true,
|
|
6764
|
-
"type": "object",
|
|
6765
|
-
"fieldTitle": "Object",
|
|
6766
|
-
"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"
|
|
6767
|
-
}
|
|
6768
|
-
},
|
|
6769
|
-
"required": [
|
|
6770
|
-
"condition"
|
|
6771
|
-
],
|
|
6772
|
-
"shortClassName": "singleConditionBean",
|
|
6773
|
-
"type": "object",
|
|
6774
|
-
"title": "Single Condition",
|
|
6775
|
-
"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"
|
|
6776
|
-
},
|
|
6777
6750
|
{
|
|
6778
6751
|
"properties": {
|
|
6779
6752
|
"conditions": {
|
|
@@ -6806,6 +6779,33 @@
|
|
|
6806
6779
|
"type": "object",
|
|
6807
6780
|
"title": "Composite Condition",
|
|
6808
6781
|
"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"
|
|
6782
|
+
},
|
|
6783
|
+
{
|
|
6784
|
+
"properties": {
|
|
6785
|
+
"condition": {
|
|
6786
|
+
"maxLength": 100,
|
|
6787
|
+
"type": "string",
|
|
6788
|
+
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
6789
|
+
},
|
|
6790
|
+
"invert": {
|
|
6791
|
+
"type": "boolean",
|
|
6792
|
+
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
6793
|
+
"defaultValue": "false"
|
|
6794
|
+
},
|
|
6795
|
+
"params": {
|
|
6796
|
+
"additionalProperties": true,
|
|
6797
|
+
"type": "object",
|
|
6798
|
+
"fieldTitle": "Object",
|
|
6799
|
+
"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"
|
|
6800
|
+
}
|
|
6801
|
+
},
|
|
6802
|
+
"required": [
|
|
6803
|
+
"condition"
|
|
6804
|
+
],
|
|
6805
|
+
"shortClassName": "singleConditionBean",
|
|
6806
|
+
"type": "object",
|
|
6807
|
+
"title": "Single Condition",
|
|
6808
|
+
"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"
|
|
6809
6809
|
}
|
|
6810
6810
|
]
|
|
6811
6811
|
},
|
|
@@ -7010,6 +7010,33 @@
|
|
|
7010
7010
|
"items": {
|
|
7011
7011
|
"type": "object",
|
|
7012
7012
|
"anyOf": [
|
|
7013
|
+
{
|
|
7014
|
+
"properties": {
|
|
7015
|
+
"condition": {
|
|
7016
|
+
"maxLength": 100,
|
|
7017
|
+
"type": "string",
|
|
7018
|
+
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
7019
|
+
},
|
|
7020
|
+
"invert": {
|
|
7021
|
+
"type": "boolean",
|
|
7022
|
+
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
7023
|
+
"defaultValue": "false"
|
|
7024
|
+
},
|
|
7025
|
+
"params": {
|
|
7026
|
+
"additionalProperties": true,
|
|
7027
|
+
"type": "object",
|
|
7028
|
+
"fieldTitle": "Object",
|
|
7029
|
+
"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"
|
|
7030
|
+
}
|
|
7031
|
+
},
|
|
7032
|
+
"required": [
|
|
7033
|
+
"condition"
|
|
7034
|
+
],
|
|
7035
|
+
"shortClassName": "singleConditionBean",
|
|
7036
|
+
"type": "object",
|
|
7037
|
+
"title": "Single Condition",
|
|
7038
|
+
"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"
|
|
7039
|
+
},
|
|
7013
7040
|
{
|
|
7014
7041
|
"properties": {
|
|
7015
7042
|
"conditions": {
|
|
@@ -7042,33 +7069,6 @@
|
|
|
7042
7069
|
"type": "object",
|
|
7043
7070
|
"title": "Composite Condition",
|
|
7044
7071
|
"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"
|
|
7045
|
-
},
|
|
7046
|
-
{
|
|
7047
|
-
"properties": {
|
|
7048
|
-
"condition": {
|
|
7049
|
-
"maxLength": 100,
|
|
7050
|
-
"type": "string",
|
|
7051
|
-
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
7052
|
-
},
|
|
7053
|
-
"invert": {
|
|
7054
|
-
"type": "boolean",
|
|
7055
|
-
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
7056
|
-
"defaultValue": "false"
|
|
7057
|
-
},
|
|
7058
|
-
"params": {
|
|
7059
|
-
"additionalProperties": true,
|
|
7060
|
-
"type": "object",
|
|
7061
|
-
"fieldTitle": "Object",
|
|
7062
|
-
"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"
|
|
7063
|
-
}
|
|
7064
|
-
},
|
|
7065
|
-
"required": [
|
|
7066
|
-
"condition"
|
|
7067
|
-
],
|
|
7068
|
-
"shortClassName": "singleConditionBean",
|
|
7069
|
-
"type": "object",
|
|
7070
|
-
"title": "Single Condition",
|
|
7071
|
-
"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"
|
|
7072
7072
|
}
|
|
7073
7073
|
]
|
|
7074
7074
|
},
|
|
@@ -7342,38 +7342,6 @@
|
|
|
7342
7342
|
"items": {
|
|
7343
7343
|
"type": "object",
|
|
7344
7344
|
"anyOf": [
|
|
7345
|
-
{
|
|
7346
|
-
"properties": {
|
|
7347
|
-
"label": {
|
|
7348
|
-
"$ref": "#/definitions/i18nProperty",
|
|
7349
|
-
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
7350
|
-
},
|
|
7351
|
-
"type": {
|
|
7352
|
-
"enum": [
|
|
7353
|
-
"button",
|
|
7354
|
-
"BUTTON"
|
|
7355
|
-
],
|
|
7356
|
-
"type": "string",
|
|
7357
|
-
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
7358
|
-
},
|
|
7359
|
-
"key": {
|
|
7360
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
7361
|
-
"maxLength": 100,
|
|
7362
|
-
"type": "string",
|
|
7363
|
-
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
7364
|
-
}
|
|
7365
|
-
},
|
|
7366
|
-
"required": [
|
|
7367
|
-
"label",
|
|
7368
|
-
"type",
|
|
7369
|
-
"key"
|
|
7370
|
-
],
|
|
7371
|
-
"additionalProperties": true,
|
|
7372
|
-
"shortClassName": "buttonControlBean",
|
|
7373
|
-
"type": "object",
|
|
7374
|
-
"title": "ButtonControl",
|
|
7375
|
-
"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"
|
|
7376
|
-
},
|
|
7377
7345
|
{
|
|
7378
7346
|
"properties": {
|
|
7379
7347
|
"controls": {
|
|
@@ -7430,6 +7398,70 @@
|
|
|
7430
7398
|
"title": "ControlGroup",
|
|
7431
7399
|
"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"
|
|
7432
7400
|
},
|
|
7401
|
+
{
|
|
7402
|
+
"properties": {
|
|
7403
|
+
"label": {
|
|
7404
|
+
"$ref": "#/definitions/i18nProperty",
|
|
7405
|
+
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
7406
|
+
},
|
|
7407
|
+
"type": {
|
|
7408
|
+
"enum": [
|
|
7409
|
+
"button",
|
|
7410
|
+
"BUTTON"
|
|
7411
|
+
],
|
|
7412
|
+
"type": "string",
|
|
7413
|
+
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
7414
|
+
},
|
|
7415
|
+
"key": {
|
|
7416
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
7417
|
+
"maxLength": 100,
|
|
7418
|
+
"type": "string",
|
|
7419
|
+
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
7420
|
+
}
|
|
7421
|
+
},
|
|
7422
|
+
"required": [
|
|
7423
|
+
"label",
|
|
7424
|
+
"type",
|
|
7425
|
+
"key"
|
|
7426
|
+
],
|
|
7427
|
+
"additionalProperties": true,
|
|
7428
|
+
"shortClassName": "buttonControlBean",
|
|
7429
|
+
"type": "object",
|
|
7430
|
+
"title": "ButtonControl",
|
|
7431
|
+
"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"
|
|
7432
|
+
},
|
|
7433
|
+
{
|
|
7434
|
+
"properties": {
|
|
7435
|
+
"macroParameter": {
|
|
7436
|
+
"maxLength": 100,
|
|
7437
|
+
"type": "string",
|
|
7438
|
+
"fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
|
|
7439
|
+
},
|
|
7440
|
+
"type": {
|
|
7441
|
+
"enum": [
|
|
7442
|
+
"text",
|
|
7443
|
+
"TEXT"
|
|
7444
|
+
],
|
|
7445
|
+
"type": "string",
|
|
7446
|
+
"fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
|
|
7447
|
+
},
|
|
7448
|
+
"key": {
|
|
7449
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
7450
|
+
"maxLength": 100,
|
|
7451
|
+
"type": "string",
|
|
7452
|
+
"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"
|
|
7453
|
+
}
|
|
7454
|
+
},
|
|
7455
|
+
"required": [
|
|
7456
|
+
"macroParameter",
|
|
7457
|
+
"type",
|
|
7458
|
+
"key"
|
|
7459
|
+
],
|
|
7460
|
+
"shortClassName": "textControlBean",
|
|
7461
|
+
"type": "object",
|
|
7462
|
+
"title": "TextControl",
|
|
7463
|
+
"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"
|
|
7464
|
+
},
|
|
7433
7465
|
{
|
|
7434
7466
|
"properties": {
|
|
7435
7467
|
"controls": {
|
|
@@ -7498,38 +7530,6 @@
|
|
|
7498
7530
|
"type": "object",
|
|
7499
7531
|
"title": "ToggleGroup",
|
|
7500
7532
|
"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"
|
|
7501
|
-
},
|
|
7502
|
-
{
|
|
7503
|
-
"properties": {
|
|
7504
|
-
"macroParameter": {
|
|
7505
|
-
"maxLength": 100,
|
|
7506
|
-
"type": "string",
|
|
7507
|
-
"fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
|
|
7508
|
-
},
|
|
7509
|
-
"type": {
|
|
7510
|
-
"enum": [
|
|
7511
|
-
"text",
|
|
7512
|
-
"TEXT"
|
|
7513
|
-
],
|
|
7514
|
-
"type": "string",
|
|
7515
|
-
"fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
|
|
7516
|
-
},
|
|
7517
|
-
"key": {
|
|
7518
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
7519
|
-
"maxLength": 100,
|
|
7520
|
-
"type": "string",
|
|
7521
|
-
"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"
|
|
7522
|
-
}
|
|
7523
|
-
},
|
|
7524
|
-
"required": [
|
|
7525
|
-
"macroParameter",
|
|
7526
|
-
"type",
|
|
7527
|
-
"key"
|
|
7528
|
-
],
|
|
7529
|
-
"shortClassName": "textControlBean",
|
|
7530
|
-
"type": "object",
|
|
7531
|
-
"title": "TextControl",
|
|
7532
|
-
"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"
|
|
7533
7533
|
}
|
|
7534
7534
|
]
|
|
7535
7535
|
},
|
|
@@ -7826,67 +7826,72 @@
|
|
|
7826
7826
|
"anyOf": [
|
|
7827
7827
|
{
|
|
7828
7828
|
"properties": {
|
|
7829
|
+
"controls": {
|
|
7830
|
+
"items": {
|
|
7831
|
+
"properties": {
|
|
7832
|
+
"macroParameterValue": {
|
|
7833
|
+
"maxLength": 10000,
|
|
7834
|
+
"type": "string",
|
|
7835
|
+
"fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n"
|
|
7836
|
+
},
|
|
7837
|
+
"label": {
|
|
7838
|
+
"$ref": "#/definitions/i18nProperty",
|
|
7839
|
+
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
7840
|
+
},
|
|
7841
|
+
"type": {
|
|
7842
|
+
"enum": [
|
|
7843
|
+
"togglebutton",
|
|
7844
|
+
"TOGGLEBUTTON"
|
|
7845
|
+
],
|
|
7846
|
+
"type": "string",
|
|
7847
|
+
"fieldDescription": "\n\nThe type field must be set to 'togglebutton'\n\n"
|
|
7848
|
+
},
|
|
7849
|
+
"key": {
|
|
7850
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
7851
|
+
"maxLength": 100,
|
|
7852
|
+
"type": "string",
|
|
7853
|
+
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
7854
|
+
}
|
|
7855
|
+
},
|
|
7856
|
+
"required": [
|
|
7857
|
+
"macroParameterValue",
|
|
7858
|
+
"label",
|
|
7859
|
+
"type",
|
|
7860
|
+
"key"
|
|
7861
|
+
],
|
|
7862
|
+
"additionalProperties": true,
|
|
7863
|
+
"shortClassName": "macroToggleButtonControlBean",
|
|
7864
|
+
"type": "object",
|
|
7865
|
+
"title": "ToggleButtonControl",
|
|
7866
|
+
"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"
|
|
7867
|
+
},
|
|
7868
|
+
"type": "array",
|
|
7869
|
+
"fieldDescription": "\n\nToggle buttons which will appear in the toggle group\n\n"
|
|
7870
|
+
},
|
|
7829
7871
|
"macroParameter": {
|
|
7872
|
+
"pattern": "[-_a-z0-9\\.]+",
|
|
7830
7873
|
"maxLength": 100,
|
|
7831
7874
|
"type": "string",
|
|
7832
|
-
"fieldDescription": "\n\nThe
|
|
7875
|
+
"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"
|
|
7833
7876
|
},
|
|
7834
7877
|
"type": {
|
|
7835
7878
|
"enum": [
|
|
7836
|
-
"
|
|
7837
|
-
"
|
|
7879
|
+
"togglegroup",
|
|
7880
|
+
"TOGGLEGROUP"
|
|
7838
7881
|
],
|
|
7839
7882
|
"type": "string",
|
|
7840
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
7841
|
-
},
|
|
7842
|
-
"key": {
|
|
7843
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
7844
|
-
"maxLength": 100,
|
|
7845
|
-
"type": "string",
|
|
7846
|
-
"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"
|
|
7883
|
+
"fieldDescription": "\n\nThe type field must be set to 'togglegroup'\n\n"
|
|
7847
7884
|
}
|
|
7848
7885
|
},
|
|
7849
7886
|
"required": [
|
|
7887
|
+
"controls",
|
|
7850
7888
|
"macroParameter",
|
|
7851
|
-
"type"
|
|
7852
|
-
"key"
|
|
7853
|
-
],
|
|
7854
|
-
"shortClassName": "textControlBean",
|
|
7855
|
-
"type": "object",
|
|
7856
|
-
"title": "TextControl",
|
|
7857
|
-
"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"
|
|
7858
|
-
},
|
|
7859
|
-
{
|
|
7860
|
-
"properties": {
|
|
7861
|
-
"label": {
|
|
7862
|
-
"$ref": "#/definitions/i18nProperty",
|
|
7863
|
-
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
7864
|
-
},
|
|
7865
|
-
"type": {
|
|
7866
|
-
"enum": [
|
|
7867
|
-
"button",
|
|
7868
|
-
"BUTTON"
|
|
7869
|
-
],
|
|
7870
|
-
"type": "string",
|
|
7871
|
-
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
7872
|
-
},
|
|
7873
|
-
"key": {
|
|
7874
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
7875
|
-
"maxLength": 100,
|
|
7876
|
-
"type": "string",
|
|
7877
|
-
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
7878
|
-
}
|
|
7879
|
-
},
|
|
7880
|
-
"required": [
|
|
7881
|
-
"label",
|
|
7882
|
-
"type",
|
|
7883
|
-
"key"
|
|
7889
|
+
"type"
|
|
7884
7890
|
],
|
|
7885
|
-
"
|
|
7886
|
-
"shortClassName": "buttonControlBean",
|
|
7891
|
+
"shortClassName": "macroToggleGroupBean",
|
|
7887
7892
|
"type": "object",
|
|
7888
|
-
"title": "
|
|
7889
|
-
"description": "\n\nDefines a
|
|
7893
|
+
"title": "ToggleGroup",
|
|
7894
|
+
"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"
|
|
7890
7895
|
},
|
|
7891
7896
|
{
|
|
7892
7897
|
"properties": {
|
|
@@ -7946,72 +7951,67 @@
|
|
|
7946
7951
|
},
|
|
7947
7952
|
{
|
|
7948
7953
|
"properties": {
|
|
7949
|
-
"controls": {
|
|
7950
|
-
"items": {
|
|
7951
|
-
"properties": {
|
|
7952
|
-
"macroParameterValue": {
|
|
7953
|
-
"maxLength": 10000,
|
|
7954
|
-
"type": "string",
|
|
7955
|
-
"fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n"
|
|
7956
|
-
},
|
|
7957
|
-
"label": {
|
|
7958
|
-
"$ref": "#/definitions/i18nProperty",
|
|
7959
|
-
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
7960
|
-
},
|
|
7961
|
-
"type": {
|
|
7962
|
-
"enum": [
|
|
7963
|
-
"togglebutton",
|
|
7964
|
-
"TOGGLEBUTTON"
|
|
7965
|
-
],
|
|
7966
|
-
"type": "string",
|
|
7967
|
-
"fieldDescription": "\n\nThe type field must be set to 'togglebutton'\n\n"
|
|
7968
|
-
},
|
|
7969
|
-
"key": {
|
|
7970
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
7971
|
-
"maxLength": 100,
|
|
7972
|
-
"type": "string",
|
|
7973
|
-
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
7974
|
-
}
|
|
7975
|
-
},
|
|
7976
|
-
"required": [
|
|
7977
|
-
"macroParameterValue",
|
|
7978
|
-
"label",
|
|
7979
|
-
"type",
|
|
7980
|
-
"key"
|
|
7981
|
-
],
|
|
7982
|
-
"additionalProperties": true,
|
|
7983
|
-
"shortClassName": "macroToggleButtonControlBean",
|
|
7984
|
-
"type": "object",
|
|
7985
|
-
"title": "ToggleButtonControl",
|
|
7986
|
-
"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"
|
|
7987
|
-
},
|
|
7988
|
-
"type": "array",
|
|
7989
|
-
"fieldDescription": "\n\nToggle buttons which will appear in the toggle group\n\n"
|
|
7990
|
-
},
|
|
7991
7954
|
"macroParameter": {
|
|
7992
|
-
"pattern": "[-_a-z0-9\\.]+",
|
|
7993
7955
|
"maxLength": 100,
|
|
7994
7956
|
"type": "string",
|
|
7995
|
-
"fieldDescription": "\n\nThe
|
|
7957
|
+
"fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
|
|
7996
7958
|
},
|
|
7997
7959
|
"type": {
|
|
7998
7960
|
"enum": [
|
|
7999
|
-
"
|
|
8000
|
-
"
|
|
7961
|
+
"text",
|
|
7962
|
+
"TEXT"
|
|
8001
7963
|
],
|
|
8002
7964
|
"type": "string",
|
|
8003
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
7965
|
+
"fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
|
|
7966
|
+
},
|
|
7967
|
+
"key": {
|
|
7968
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
7969
|
+
"maxLength": 100,
|
|
7970
|
+
"type": "string",
|
|
7971
|
+
"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"
|
|
8004
7972
|
}
|
|
8005
7973
|
},
|
|
8006
7974
|
"required": [
|
|
8007
|
-
"controls",
|
|
8008
7975
|
"macroParameter",
|
|
8009
|
-
"type"
|
|
7976
|
+
"type",
|
|
7977
|
+
"key"
|
|
8010
7978
|
],
|
|
8011
|
-
"shortClassName": "
|
|
7979
|
+
"shortClassName": "textControlBean",
|
|
8012
7980
|
"type": "object",
|
|
8013
|
-
"title": "
|
|
8014
|
-
"description": "\n\nDefines a
|
|
7981
|
+
"title": "TextControl",
|
|
7982
|
+
"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"
|
|
7983
|
+
},
|
|
7984
|
+
{
|
|
7985
|
+
"properties": {
|
|
7986
|
+
"label": {
|
|
7987
|
+
"$ref": "#/definitions/i18nProperty",
|
|
7988
|
+
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
7989
|
+
},
|
|
7990
|
+
"type": {
|
|
7991
|
+
"enum": [
|
|
7992
|
+
"button",
|
|
7993
|
+
"BUTTON"
|
|
7994
|
+
],
|
|
7995
|
+
"type": "string",
|
|
7996
|
+
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
7997
|
+
},
|
|
7998
|
+
"key": {
|
|
7999
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
8000
|
+
"maxLength": 100,
|
|
8001
|
+
"type": "string",
|
|
8002
|
+
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
8003
|
+
}
|
|
8004
|
+
},
|
|
8005
|
+
"required": [
|
|
8006
|
+
"label",
|
|
8007
|
+
"type",
|
|
8008
|
+
"key"
|
|
8009
|
+
],
|
|
8010
|
+
"additionalProperties": true,
|
|
8011
|
+
"shortClassName": "buttonControlBean",
|
|
8012
|
+
"type": "object",
|
|
8013
|
+
"title": "ButtonControl",
|
|
8014
|
+
"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"
|
|
8015
8015
|
}
|
|
8016
8016
|
]
|
|
8017
8017
|
},
|
|
@@ -8247,6 +8247,22 @@
|
|
|
8247
8247
|
"type": "object",
|
|
8248
8248
|
"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",
|
|
8249
8249
|
"anyOf": [
|
|
8250
|
+
{
|
|
8251
|
+
"properties": {
|
|
8252
|
+
"key": {
|
|
8253
|
+
"maxLength": 100,
|
|
8254
|
+
"type": "string",
|
|
8255
|
+
"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"
|
|
8256
|
+
}
|
|
8257
|
+
},
|
|
8258
|
+
"required": [
|
|
8259
|
+
"key"
|
|
8260
|
+
],
|
|
8261
|
+
"shortClassName": "dialogModuleOptions",
|
|
8262
|
+
"type": "object",
|
|
8263
|
+
"title": "Dialog Module Options",
|
|
8264
|
+
"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"
|
|
8265
|
+
},
|
|
8250
8266
|
{
|
|
8251
8267
|
"properties": {
|
|
8252
8268
|
"size": {
|
|
@@ -8292,22 +8308,6 @@
|
|
|
8292
8308
|
"title": "Dialog Options",
|
|
8293
8309
|
"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"
|
|
8294
8310
|
},
|
|
8295
|
-
{
|
|
8296
|
-
"properties": {
|
|
8297
|
-
"key": {
|
|
8298
|
-
"maxLength": 100,
|
|
8299
|
-
"type": "string",
|
|
8300
|
-
"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"
|
|
8301
|
-
}
|
|
8302
|
-
},
|
|
8303
|
-
"required": [
|
|
8304
|
-
"key"
|
|
8305
|
-
],
|
|
8306
|
-
"shortClassName": "dialogModuleOptions",
|
|
8307
|
-
"type": "object",
|
|
8308
|
-
"title": "Dialog Module Options",
|
|
8309
|
-
"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"
|
|
8310
|
-
},
|
|
8311
8311
|
{
|
|
8312
8312
|
"properties": {
|
|
8313
8313
|
"offsetX": {
|