@forge/manifest 3.3.0-next.1 → 3.3.0-next.2
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 +9 -0
- package/out/schema/manifest-schema.json +198 -198
- package/out/schema/manifest.d.ts +228 -228
- package/package.json +2 -2
|
@@ -6299,10 +6299,10 @@
|
|
|
6299
6299
|
"type": "object",
|
|
6300
6300
|
"anyOf": [
|
|
6301
6301
|
{
|
|
6302
|
-
"$ref": "#/definitions/
|
|
6302
|
+
"$ref": "#/definitions/singleCondition"
|
|
6303
6303
|
},
|
|
6304
6304
|
{
|
|
6305
|
-
"$ref": "#/definitions/
|
|
6305
|
+
"$ref": "#/definitions/compositeCondition"
|
|
6306
6306
|
}
|
|
6307
6307
|
]
|
|
6308
6308
|
},
|
|
@@ -6607,51 +6607,6 @@
|
|
|
6607
6607
|
"type": "object",
|
|
6608
6608
|
"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",
|
|
6609
6609
|
"anyOf": [
|
|
6610
|
-
{
|
|
6611
|
-
"properties": {
|
|
6612
|
-
"size": {
|
|
6613
|
-
"enum": [
|
|
6614
|
-
"small",
|
|
6615
|
-
"SMALL",
|
|
6616
|
-
"medium",
|
|
6617
|
-
"MEDIUM",
|
|
6618
|
-
"large",
|
|
6619
|
-
"LARGE",
|
|
6620
|
-
"x-large",
|
|
6621
|
-
"X-LARGE",
|
|
6622
|
-
"fullscreen",
|
|
6623
|
-
"FULLSCREEN",
|
|
6624
|
-
"maximum",
|
|
6625
|
-
"MAXIMUM"
|
|
6626
|
-
],
|
|
6627
|
-
"type": "string",
|
|
6628
|
-
"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"
|
|
6629
|
-
},
|
|
6630
|
-
"chrome": {
|
|
6631
|
-
"type": "boolean",
|
|
6632
|
-
"fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
|
|
6633
|
-
"defaultValue": "true"
|
|
6634
|
-
},
|
|
6635
|
-
"width": {
|
|
6636
|
-
"maxLength": 10,
|
|
6637
|
-
"type": "string",
|
|
6638
|
-
"fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
|
|
6639
|
-
},
|
|
6640
|
-
"header": {
|
|
6641
|
-
"$ref": "#/definitions/i18nProperty",
|
|
6642
|
-
"fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
|
|
6643
|
-
},
|
|
6644
|
-
"height": {
|
|
6645
|
-
"maxLength": 10,
|
|
6646
|
-
"type": "string",
|
|
6647
|
-
"fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
|
|
6648
|
-
}
|
|
6649
|
-
},
|
|
6650
|
-
"shortClassName": "dialogOptions",
|
|
6651
|
-
"type": "object",
|
|
6652
|
-
"title": "Dialog Options",
|
|
6653
|
-
"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"
|
|
6654
|
-
},
|
|
6655
6610
|
{
|
|
6656
6611
|
"properties": {
|
|
6657
6612
|
"key": {
|
|
@@ -6714,6 +6669,51 @@
|
|
|
6714
6669
|
"type": "object",
|
|
6715
6670
|
"title": "Inline Dialog Options",
|
|
6716
6671
|
"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"
|
|
6672
|
+
},
|
|
6673
|
+
{
|
|
6674
|
+
"properties": {
|
|
6675
|
+
"size": {
|
|
6676
|
+
"enum": [
|
|
6677
|
+
"small",
|
|
6678
|
+
"SMALL",
|
|
6679
|
+
"medium",
|
|
6680
|
+
"MEDIUM",
|
|
6681
|
+
"large",
|
|
6682
|
+
"LARGE",
|
|
6683
|
+
"x-large",
|
|
6684
|
+
"X-LARGE",
|
|
6685
|
+
"fullscreen",
|
|
6686
|
+
"FULLSCREEN",
|
|
6687
|
+
"maximum",
|
|
6688
|
+
"MAXIMUM"
|
|
6689
|
+
],
|
|
6690
|
+
"type": "string",
|
|
6691
|
+
"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"
|
|
6692
|
+
},
|
|
6693
|
+
"chrome": {
|
|
6694
|
+
"type": "boolean",
|
|
6695
|
+
"fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
|
|
6696
|
+
"defaultValue": "true"
|
|
6697
|
+
},
|
|
6698
|
+
"width": {
|
|
6699
|
+
"maxLength": 10,
|
|
6700
|
+
"type": "string",
|
|
6701
|
+
"fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
|
|
6702
|
+
},
|
|
6703
|
+
"header": {
|
|
6704
|
+
"$ref": "#/definitions/i18nProperty",
|
|
6705
|
+
"fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
|
|
6706
|
+
},
|
|
6707
|
+
"height": {
|
|
6708
|
+
"maxLength": 10,
|
|
6709
|
+
"type": "string",
|
|
6710
|
+
"fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
|
|
6711
|
+
}
|
|
6712
|
+
},
|
|
6713
|
+
"shortClassName": "dialogOptions",
|
|
6714
|
+
"type": "object",
|
|
6715
|
+
"title": "Dialog Options",
|
|
6716
|
+
"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"
|
|
6717
6717
|
}
|
|
6718
6718
|
]
|
|
6719
6719
|
},
|
|
@@ -6770,33 +6770,6 @@
|
|
|
6770
6770
|
"items": {
|
|
6771
6771
|
"type": "object",
|
|
6772
6772
|
"anyOf": [
|
|
6773
|
-
{
|
|
6774
|
-
"properties": {
|
|
6775
|
-
"condition": {
|
|
6776
|
-
"maxLength": 100,
|
|
6777
|
-
"type": "string",
|
|
6778
|
-
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
6779
|
-
},
|
|
6780
|
-
"invert": {
|
|
6781
|
-
"type": "boolean",
|
|
6782
|
-
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
6783
|
-
"defaultValue": "false"
|
|
6784
|
-
},
|
|
6785
|
-
"params": {
|
|
6786
|
-
"additionalProperties": true,
|
|
6787
|
-
"type": "object",
|
|
6788
|
-
"fieldTitle": "Object",
|
|
6789
|
-
"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"
|
|
6790
|
-
}
|
|
6791
|
-
},
|
|
6792
|
-
"required": [
|
|
6793
|
-
"condition"
|
|
6794
|
-
],
|
|
6795
|
-
"shortClassName": "singleConditionBean",
|
|
6796
|
-
"type": "object",
|
|
6797
|
-
"title": "Single Condition",
|
|
6798
|
-
"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"
|
|
6799
|
-
},
|
|
6800
6773
|
{
|
|
6801
6774
|
"properties": {
|
|
6802
6775
|
"conditions": {
|
|
@@ -6804,10 +6777,10 @@
|
|
|
6804
6777
|
"type": "object",
|
|
6805
6778
|
"anyOf": [
|
|
6806
6779
|
{
|
|
6807
|
-
"$ref": "
|
|
6780
|
+
"$ref": "#/definitions/singleCondition"
|
|
6808
6781
|
},
|
|
6809
6782
|
{
|
|
6810
|
-
"$ref": "
|
|
6783
|
+
"$ref": "#"
|
|
6811
6784
|
}
|
|
6812
6785
|
]
|
|
6813
6786
|
},
|
|
@@ -6829,6 +6802,33 @@
|
|
|
6829
6802
|
"type": "object",
|
|
6830
6803
|
"title": "Composite Condition",
|
|
6831
6804
|
"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"
|
|
6805
|
+
},
|
|
6806
|
+
{
|
|
6807
|
+
"properties": {
|
|
6808
|
+
"condition": {
|
|
6809
|
+
"maxLength": 100,
|
|
6810
|
+
"type": "string",
|
|
6811
|
+
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
6812
|
+
},
|
|
6813
|
+
"invert": {
|
|
6814
|
+
"type": "boolean",
|
|
6815
|
+
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
6816
|
+
"defaultValue": "false"
|
|
6817
|
+
},
|
|
6818
|
+
"params": {
|
|
6819
|
+
"additionalProperties": true,
|
|
6820
|
+
"type": "object",
|
|
6821
|
+
"fieldTitle": "Object",
|
|
6822
|
+
"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"
|
|
6823
|
+
}
|
|
6824
|
+
},
|
|
6825
|
+
"required": [
|
|
6826
|
+
"condition"
|
|
6827
|
+
],
|
|
6828
|
+
"shortClassName": "singleConditionBean",
|
|
6829
|
+
"type": "object",
|
|
6830
|
+
"title": "Single Condition",
|
|
6831
|
+
"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"
|
|
6832
6832
|
}
|
|
6833
6833
|
]
|
|
6834
6834
|
},
|
|
@@ -7033,6 +7033,33 @@
|
|
|
7033
7033
|
"items": {
|
|
7034
7034
|
"type": "object",
|
|
7035
7035
|
"anyOf": [
|
|
7036
|
+
{
|
|
7037
|
+
"properties": {
|
|
7038
|
+
"condition": {
|
|
7039
|
+
"maxLength": 100,
|
|
7040
|
+
"type": "string",
|
|
7041
|
+
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
7042
|
+
},
|
|
7043
|
+
"invert": {
|
|
7044
|
+
"type": "boolean",
|
|
7045
|
+
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
7046
|
+
"defaultValue": "false"
|
|
7047
|
+
},
|
|
7048
|
+
"params": {
|
|
7049
|
+
"additionalProperties": true,
|
|
7050
|
+
"type": "object",
|
|
7051
|
+
"fieldTitle": "Object",
|
|
7052
|
+
"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"
|
|
7053
|
+
}
|
|
7054
|
+
},
|
|
7055
|
+
"required": [
|
|
7056
|
+
"condition"
|
|
7057
|
+
],
|
|
7058
|
+
"shortClassName": "singleConditionBean",
|
|
7059
|
+
"type": "object",
|
|
7060
|
+
"title": "Single Condition",
|
|
7061
|
+
"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"
|
|
7062
|
+
},
|
|
7036
7063
|
{
|
|
7037
7064
|
"properties": {
|
|
7038
7065
|
"conditions": {
|
|
@@ -7065,33 +7092,6 @@
|
|
|
7065
7092
|
"type": "object",
|
|
7066
7093
|
"title": "Composite Condition",
|
|
7067
7094
|
"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"
|
|
7068
|
-
},
|
|
7069
|
-
{
|
|
7070
|
-
"properties": {
|
|
7071
|
-
"condition": {
|
|
7072
|
-
"maxLength": 100,
|
|
7073
|
-
"type": "string",
|
|
7074
|
-
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
7075
|
-
},
|
|
7076
|
-
"invert": {
|
|
7077
|
-
"type": "boolean",
|
|
7078
|
-
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
7079
|
-
"defaultValue": "false"
|
|
7080
|
-
},
|
|
7081
|
-
"params": {
|
|
7082
|
-
"additionalProperties": true,
|
|
7083
|
-
"type": "object",
|
|
7084
|
-
"fieldTitle": "Object",
|
|
7085
|
-
"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"
|
|
7086
|
-
}
|
|
7087
|
-
},
|
|
7088
|
-
"required": [
|
|
7089
|
-
"condition"
|
|
7090
|
-
],
|
|
7091
|
-
"shortClassName": "singleConditionBean",
|
|
7092
|
-
"type": "object",
|
|
7093
|
-
"title": "Single Condition",
|
|
7094
|
-
"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"
|
|
7095
7095
|
}
|
|
7096
7096
|
]
|
|
7097
7097
|
},
|
|
@@ -7370,22 +7370,17 @@
|
|
|
7370
7370
|
"controls": {
|
|
7371
7371
|
"items": {
|
|
7372
7372
|
"properties": {
|
|
7373
|
-
"macroParameterValue": {
|
|
7374
|
-
"maxLength": 10000,
|
|
7375
|
-
"type": "string",
|
|
7376
|
-
"fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n"
|
|
7377
|
-
},
|
|
7378
7373
|
"label": {
|
|
7379
7374
|
"$ref": "#/definitions/i18nProperty",
|
|
7380
7375
|
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
7381
7376
|
},
|
|
7382
7377
|
"type": {
|
|
7383
7378
|
"enum": [
|
|
7384
|
-
"
|
|
7385
|
-
"
|
|
7379
|
+
"button",
|
|
7380
|
+
"BUTTON"
|
|
7386
7381
|
],
|
|
7387
7382
|
"type": "string",
|
|
7388
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
7383
|
+
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
7389
7384
|
},
|
|
7390
7385
|
"key": {
|
|
7391
7386
|
"pattern": "^[a-zA-Z0-9-]+$",
|
|
@@ -7395,93 +7390,90 @@
|
|
|
7395
7390
|
}
|
|
7396
7391
|
},
|
|
7397
7392
|
"required": [
|
|
7398
|
-
"macroParameterValue",
|
|
7399
7393
|
"label",
|
|
7400
7394
|
"type",
|
|
7401
7395
|
"key"
|
|
7402
7396
|
],
|
|
7403
7397
|
"additionalProperties": true,
|
|
7404
|
-
"shortClassName": "
|
|
7398
|
+
"shortClassName": "buttonControlBean",
|
|
7405
7399
|
"type": "object",
|
|
7406
|
-
"title": "
|
|
7407
|
-
"description": "\n\nDefines a
|
|
7400
|
+
"title": "ButtonControl",
|
|
7401
|
+
"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"
|
|
7408
7402
|
},
|
|
7409
7403
|
"type": "array",
|
|
7410
|
-
"fieldDescription": "\n\
|
|
7411
|
-
},
|
|
7412
|
-
"macroParameter": {
|
|
7413
|
-
"pattern": "[-_a-z0-9\\.]+",
|
|
7414
|
-
"maxLength": 100,
|
|
7415
|
-
"type": "string",
|
|
7416
|
-
"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"
|
|
7404
|
+
"fieldDescription": "\n\nControls which will appear in the control group\n\n"
|
|
7417
7405
|
},
|
|
7418
7406
|
"type": {
|
|
7419
7407
|
"enum": [
|
|
7420
|
-
"
|
|
7421
|
-
"
|
|
7408
|
+
"group",
|
|
7409
|
+
"GROUP"
|
|
7422
7410
|
],
|
|
7423
7411
|
"type": "string",
|
|
7424
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
7412
|
+
"fieldDescription": "\n\nThe type field must be set to 'group'\n\n"
|
|
7425
7413
|
}
|
|
7426
7414
|
},
|
|
7427
7415
|
"required": [
|
|
7428
7416
|
"controls",
|
|
7429
|
-
"macroParameter",
|
|
7430
7417
|
"type"
|
|
7431
7418
|
],
|
|
7432
|
-
"shortClassName": "
|
|
7419
|
+
"shortClassName": "controlGroupBean",
|
|
7433
7420
|
"type": "object",
|
|
7434
|
-
"title": "
|
|
7435
|
-
"description": "\n\nDefines a
|
|
7421
|
+
"title": "ControlGroup",
|
|
7422
|
+
"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"
|
|
7436
7423
|
},
|
|
7437
7424
|
{
|
|
7438
7425
|
"properties": {
|
|
7439
|
-
"
|
|
7440
|
-
"
|
|
7441
|
-
"
|
|
7426
|
+
"macroParameter": {
|
|
7427
|
+
"maxLength": 100,
|
|
7428
|
+
"type": "string",
|
|
7429
|
+
"fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
|
|
7442
7430
|
},
|
|
7443
7431
|
"type": {
|
|
7444
7432
|
"enum": [
|
|
7445
|
-
"
|
|
7446
|
-
"
|
|
7433
|
+
"text",
|
|
7434
|
+
"TEXT"
|
|
7447
7435
|
],
|
|
7448
7436
|
"type": "string",
|
|
7449
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
7437
|
+
"fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
|
|
7450
7438
|
},
|
|
7451
7439
|
"key": {
|
|
7452
7440
|
"pattern": "^[a-zA-Z0-9-]+$",
|
|
7453
7441
|
"maxLength": 100,
|
|
7454
7442
|
"type": "string",
|
|
7455
|
-
"fieldDescription": "\n\nA key to identify the
|
|
7443
|
+
"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"
|
|
7456
7444
|
}
|
|
7457
7445
|
},
|
|
7458
7446
|
"required": [
|
|
7459
|
-
"
|
|
7447
|
+
"macroParameter",
|
|
7460
7448
|
"type",
|
|
7461
7449
|
"key"
|
|
7462
7450
|
],
|
|
7463
|
-
"
|
|
7464
|
-
"shortClassName": "buttonControlBean",
|
|
7451
|
+
"shortClassName": "textControlBean",
|
|
7465
7452
|
"type": "object",
|
|
7466
|
-
"title": "
|
|
7467
|
-
"description": "\n\nDefines a
|
|
7453
|
+
"title": "TextControl",
|
|
7454
|
+
"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"
|
|
7468
7455
|
},
|
|
7469
7456
|
{
|
|
7470
7457
|
"properties": {
|
|
7471
7458
|
"controls": {
|
|
7472
7459
|
"items": {
|
|
7473
7460
|
"properties": {
|
|
7461
|
+
"macroParameterValue": {
|
|
7462
|
+
"maxLength": 10000,
|
|
7463
|
+
"type": "string",
|
|
7464
|
+
"fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n"
|
|
7465
|
+
},
|
|
7474
7466
|
"label": {
|
|
7475
7467
|
"$ref": "#/definitions/i18nProperty",
|
|
7476
7468
|
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
7477
7469
|
},
|
|
7478
7470
|
"type": {
|
|
7479
7471
|
"enum": [
|
|
7480
|
-
"
|
|
7481
|
-
"
|
|
7472
|
+
"togglebutton",
|
|
7473
|
+
"TOGGLEBUTTON"
|
|
7482
7474
|
],
|
|
7483
7475
|
"type": "string",
|
|
7484
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
7476
|
+
"fieldDescription": "\n\nThe type field must be set to 'togglebutton'\n\n"
|
|
7485
7477
|
},
|
|
7486
7478
|
"key": {
|
|
7487
7479
|
"pattern": "^[a-zA-Z0-9-]+$",
|
|
@@ -7491,68 +7483,76 @@
|
|
|
7491
7483
|
}
|
|
7492
7484
|
},
|
|
7493
7485
|
"required": [
|
|
7486
|
+
"macroParameterValue",
|
|
7494
7487
|
"label",
|
|
7495
7488
|
"type",
|
|
7496
7489
|
"key"
|
|
7497
7490
|
],
|
|
7498
7491
|
"additionalProperties": true,
|
|
7499
|
-
"shortClassName": "
|
|
7492
|
+
"shortClassName": "macroToggleButtonControlBean",
|
|
7500
7493
|
"type": "object",
|
|
7501
|
-
"title": "
|
|
7502
|
-
"description": "\n\nDefines a button which
|
|
7494
|
+
"title": "ToggleButtonControl",
|
|
7495
|
+
"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"
|
|
7503
7496
|
},
|
|
7504
7497
|
"type": "array",
|
|
7505
|
-
"fieldDescription": "\n\
|
|
7498
|
+
"fieldDescription": "\n\nToggle buttons which will appear in the toggle group\n\n"
|
|
7499
|
+
},
|
|
7500
|
+
"macroParameter": {
|
|
7501
|
+
"pattern": "[-_a-z0-9\\.]+",
|
|
7502
|
+
"maxLength": 100,
|
|
7503
|
+
"type": "string",
|
|
7504
|
+
"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"
|
|
7506
7505
|
},
|
|
7507
7506
|
"type": {
|
|
7508
7507
|
"enum": [
|
|
7509
|
-
"
|
|
7510
|
-
"
|
|
7508
|
+
"togglegroup",
|
|
7509
|
+
"TOGGLEGROUP"
|
|
7511
7510
|
],
|
|
7512
7511
|
"type": "string",
|
|
7513
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
7512
|
+
"fieldDescription": "\n\nThe type field must be set to 'togglegroup'\n\n"
|
|
7514
7513
|
}
|
|
7515
7514
|
},
|
|
7516
7515
|
"required": [
|
|
7517
7516
|
"controls",
|
|
7517
|
+
"macroParameter",
|
|
7518
7518
|
"type"
|
|
7519
7519
|
],
|
|
7520
|
-
"shortClassName": "
|
|
7520
|
+
"shortClassName": "macroToggleGroupBean",
|
|
7521
7521
|
"type": "object",
|
|
7522
|
-
"title": "
|
|
7523
|
-
"description": "\n\nDefines a
|
|
7522
|
+
"title": "ToggleGroup",
|
|
7523
|
+
"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"
|
|
7524
7524
|
},
|
|
7525
7525
|
{
|
|
7526
7526
|
"properties": {
|
|
7527
|
-
"
|
|
7528
|
-
"
|
|
7529
|
-
"
|
|
7530
|
-
"fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
|
|
7527
|
+
"label": {
|
|
7528
|
+
"$ref": "#/definitions/i18nProperty",
|
|
7529
|
+
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
7531
7530
|
},
|
|
7532
7531
|
"type": {
|
|
7533
7532
|
"enum": [
|
|
7534
|
-
"
|
|
7535
|
-
"
|
|
7533
|
+
"button",
|
|
7534
|
+
"BUTTON"
|
|
7536
7535
|
],
|
|
7537
7536
|
"type": "string",
|
|
7538
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
7537
|
+
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
7539
7538
|
},
|
|
7540
7539
|
"key": {
|
|
7541
7540
|
"pattern": "^[a-zA-Z0-9-]+$",
|
|
7542
7541
|
"maxLength": 100,
|
|
7543
7542
|
"type": "string",
|
|
7544
|
-
"fieldDescription": "\n\nA key to identify
|
|
7543
|
+
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
7545
7544
|
}
|
|
7546
7545
|
},
|
|
7547
7546
|
"required": [
|
|
7548
|
-
"
|
|
7547
|
+
"label",
|
|
7549
7548
|
"type",
|
|
7550
7549
|
"key"
|
|
7551
7550
|
],
|
|
7552
|
-
"
|
|
7551
|
+
"additionalProperties": true,
|
|
7552
|
+
"shortClassName": "buttonControlBean",
|
|
7553
7553
|
"type": "object",
|
|
7554
|
-
"title": "
|
|
7555
|
-
"description": "\n\nDefines a
|
|
7554
|
+
"title": "ButtonControl",
|
|
7555
|
+
"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"
|
|
7556
7556
|
}
|
|
7557
7557
|
]
|
|
7558
7558
|
},
|
|
@@ -7847,6 +7847,38 @@
|
|
|
7847
7847
|
"items": {
|
|
7848
7848
|
"type": "object",
|
|
7849
7849
|
"anyOf": [
|
|
7850
|
+
{
|
|
7851
|
+
"properties": {
|
|
7852
|
+
"macroParameter": {
|
|
7853
|
+
"maxLength": 100,
|
|
7854
|
+
"type": "string",
|
|
7855
|
+
"fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
|
|
7856
|
+
},
|
|
7857
|
+
"type": {
|
|
7858
|
+
"enum": [
|
|
7859
|
+
"text",
|
|
7860
|
+
"TEXT"
|
|
7861
|
+
],
|
|
7862
|
+
"type": "string",
|
|
7863
|
+
"fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
|
|
7864
|
+
},
|
|
7865
|
+
"key": {
|
|
7866
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
7867
|
+
"maxLength": 100,
|
|
7868
|
+
"type": "string",
|
|
7869
|
+
"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"
|
|
7870
|
+
}
|
|
7871
|
+
},
|
|
7872
|
+
"required": [
|
|
7873
|
+
"macroParameter",
|
|
7874
|
+
"type",
|
|
7875
|
+
"key"
|
|
7876
|
+
],
|
|
7877
|
+
"shortClassName": "textControlBean",
|
|
7878
|
+
"type": "object",
|
|
7879
|
+
"title": "TextControl",
|
|
7880
|
+
"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"
|
|
7881
|
+
},
|
|
7850
7882
|
{
|
|
7851
7883
|
"properties": {
|
|
7852
7884
|
"controls": {
|
|
@@ -8003,38 +8035,6 @@
|
|
|
8003
8035
|
"type": "object",
|
|
8004
8036
|
"title": "ButtonControl",
|
|
8005
8037
|
"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"
|
|
8006
|
-
},
|
|
8007
|
-
{
|
|
8008
|
-
"properties": {
|
|
8009
|
-
"macroParameter": {
|
|
8010
|
-
"maxLength": 100,
|
|
8011
|
-
"type": "string",
|
|
8012
|
-
"fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
|
|
8013
|
-
},
|
|
8014
|
-
"type": {
|
|
8015
|
-
"enum": [
|
|
8016
|
-
"text",
|
|
8017
|
-
"TEXT"
|
|
8018
|
-
],
|
|
8019
|
-
"type": "string",
|
|
8020
|
-
"fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
|
|
8021
|
-
},
|
|
8022
|
-
"key": {
|
|
8023
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
8024
|
-
"maxLength": 100,
|
|
8025
|
-
"type": "string",
|
|
8026
|
-
"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"
|
|
8027
|
-
}
|
|
8028
|
-
},
|
|
8029
|
-
"required": [
|
|
8030
|
-
"macroParameter",
|
|
8031
|
-
"type",
|
|
8032
|
-
"key"
|
|
8033
|
-
],
|
|
8034
|
-
"shortClassName": "textControlBean",
|
|
8035
|
-
"type": "object",
|
|
8036
|
-
"title": "TextControl",
|
|
8037
|
-
"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"
|
|
8038
8038
|
}
|
|
8039
8039
|
]
|
|
8040
8040
|
},
|