@forge/manifest 3.1.1-next.1 → 3.2.0-next.5
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 +24 -0
- package/out/schema/basic-manifest-schema.json +23 -0
- package/out/schema/basic-manifest.d.ts +9 -0
- package/out/schema/manifest-schema.json +343 -285
- package/out/schema/manifest.d.ts +373 -351
- package/out/text/errors.d.ts +4 -0
- package/out/text/errors.d.ts.map +1 -1
- package/out/text/errors.js +4 -0
- package/out/validators/modules-validator.d.ts.map +1 -1
- package/out/validators/modules-validator.js +12 -3
- package/package.json +1 -1
|
@@ -80,6 +80,29 @@
|
|
|
80
80
|
]
|
|
81
81
|
}
|
|
82
82
|
}
|
|
83
|
+
},
|
|
84
|
+
"storage": {
|
|
85
|
+
"description": "Options related to hosted storage",
|
|
86
|
+
"type": "object",
|
|
87
|
+
"required": [
|
|
88
|
+
"classifications"
|
|
89
|
+
],
|
|
90
|
+
"additionalProperties": false,
|
|
91
|
+
"properties": {
|
|
92
|
+
"classifications": {
|
|
93
|
+
"description": "Labels to classify the type of data stored",
|
|
94
|
+
"type": "array",
|
|
95
|
+
"items": {
|
|
96
|
+
"type": "string",
|
|
97
|
+
"enum": [
|
|
98
|
+
"ugc",
|
|
99
|
+
"pii",
|
|
100
|
+
"other"
|
|
101
|
+
]
|
|
102
|
+
},
|
|
103
|
+
"minItems": 1
|
|
104
|
+
}
|
|
105
|
+
}
|
|
83
106
|
}
|
|
84
107
|
},
|
|
85
108
|
"required": [
|
|
@@ -6584,51 +6607,6 @@
|
|
|
6584
6607
|
"type": "object",
|
|
6585
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",
|
|
6586
6609
|
"anyOf": [
|
|
6587
|
-
{
|
|
6588
|
-
"properties": {
|
|
6589
|
-
"size": {
|
|
6590
|
-
"enum": [
|
|
6591
|
-
"small",
|
|
6592
|
-
"SMALL",
|
|
6593
|
-
"medium",
|
|
6594
|
-
"MEDIUM",
|
|
6595
|
-
"large",
|
|
6596
|
-
"LARGE",
|
|
6597
|
-
"x-large",
|
|
6598
|
-
"X-LARGE",
|
|
6599
|
-
"fullscreen",
|
|
6600
|
-
"FULLSCREEN",
|
|
6601
|
-
"maximum",
|
|
6602
|
-
"MAXIMUM"
|
|
6603
|
-
],
|
|
6604
|
-
"type": "string",
|
|
6605
|
-
"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"
|
|
6606
|
-
},
|
|
6607
|
-
"chrome": {
|
|
6608
|
-
"type": "boolean",
|
|
6609
|
-
"fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
|
|
6610
|
-
"defaultValue": "true"
|
|
6611
|
-
},
|
|
6612
|
-
"width": {
|
|
6613
|
-
"maxLength": 10,
|
|
6614
|
-
"type": "string",
|
|
6615
|
-
"fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
|
|
6616
|
-
},
|
|
6617
|
-
"header": {
|
|
6618
|
-
"$ref": "#/definitions/i18nProperty",
|
|
6619
|
-
"fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
|
|
6620
|
-
},
|
|
6621
|
-
"height": {
|
|
6622
|
-
"maxLength": 10,
|
|
6623
|
-
"type": "string",
|
|
6624
|
-
"fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
|
|
6625
|
-
}
|
|
6626
|
-
},
|
|
6627
|
-
"shortClassName": "dialogOptions",
|
|
6628
|
-
"type": "object",
|
|
6629
|
-
"title": "Dialog Options",
|
|
6630
|
-
"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"
|
|
6631
|
-
},
|
|
6632
6610
|
{
|
|
6633
6611
|
"properties": {
|
|
6634
6612
|
"offsetX": {
|
|
@@ -6676,6 +6654,51 @@
|
|
|
6676
6654
|
"title": "Inline Dialog Options",
|
|
6677
6655
|
"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
6656
|
},
|
|
6657
|
+
{
|
|
6658
|
+
"properties": {
|
|
6659
|
+
"size": {
|
|
6660
|
+
"enum": [
|
|
6661
|
+
"small",
|
|
6662
|
+
"SMALL",
|
|
6663
|
+
"medium",
|
|
6664
|
+
"MEDIUM",
|
|
6665
|
+
"large",
|
|
6666
|
+
"LARGE",
|
|
6667
|
+
"x-large",
|
|
6668
|
+
"X-LARGE",
|
|
6669
|
+
"fullscreen",
|
|
6670
|
+
"FULLSCREEN",
|
|
6671
|
+
"maximum",
|
|
6672
|
+
"MAXIMUM"
|
|
6673
|
+
],
|
|
6674
|
+
"type": "string",
|
|
6675
|
+
"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"
|
|
6676
|
+
},
|
|
6677
|
+
"chrome": {
|
|
6678
|
+
"type": "boolean",
|
|
6679
|
+
"fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
|
|
6680
|
+
"defaultValue": "true"
|
|
6681
|
+
},
|
|
6682
|
+
"width": {
|
|
6683
|
+
"maxLength": 10,
|
|
6684
|
+
"type": "string",
|
|
6685
|
+
"fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
|
|
6686
|
+
},
|
|
6687
|
+
"header": {
|
|
6688
|
+
"$ref": "#/definitions/i18nProperty",
|
|
6689
|
+
"fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
|
|
6690
|
+
},
|
|
6691
|
+
"height": {
|
|
6692
|
+
"maxLength": 10,
|
|
6693
|
+
"type": "string",
|
|
6694
|
+
"fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
|
|
6695
|
+
}
|
|
6696
|
+
},
|
|
6697
|
+
"shortClassName": "dialogOptions",
|
|
6698
|
+
"type": "object",
|
|
6699
|
+
"title": "Dialog Options",
|
|
6700
|
+
"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"
|
|
6701
|
+
},
|
|
6679
6702
|
{
|
|
6680
6703
|
"properties": {
|
|
6681
6704
|
"key": {
|
|
@@ -6747,6 +6770,33 @@
|
|
|
6747
6770
|
"items": {
|
|
6748
6771
|
"type": "object",
|
|
6749
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
|
+
},
|
|
6750
6800
|
{
|
|
6751
6801
|
"properties": {
|
|
6752
6802
|
"conditions": {
|
|
@@ -6754,10 +6804,10 @@
|
|
|
6754
6804
|
"type": "object",
|
|
6755
6805
|
"anyOf": [
|
|
6756
6806
|
{
|
|
6757
|
-
"$ref": "
|
|
6807
|
+
"$ref": "#/definitions/singleCondition"
|
|
6758
6808
|
},
|
|
6759
6809
|
{
|
|
6760
|
-
"$ref": "
|
|
6810
|
+
"$ref": "#"
|
|
6761
6811
|
}
|
|
6762
6812
|
]
|
|
6763
6813
|
},
|
|
@@ -6779,33 +6829,6 @@
|
|
|
6779
6829
|
"type": "object",
|
|
6780
6830
|
"title": "Composite Condition",
|
|
6781
6831
|
"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
6832
|
}
|
|
6810
6833
|
]
|
|
6811
6834
|
},
|
|
@@ -7044,10 +7067,10 @@
|
|
|
7044
7067
|
"type": "object",
|
|
7045
7068
|
"anyOf": [
|
|
7046
7069
|
{
|
|
7047
|
-
"$ref": "
|
|
7070
|
+
"$ref": "#"
|
|
7048
7071
|
},
|
|
7049
7072
|
{
|
|
7050
|
-
"$ref": "
|
|
7073
|
+
"$ref": "#/definitions/singleCondition"
|
|
7051
7074
|
}
|
|
7052
7075
|
]
|
|
7053
7076
|
},
|
|
@@ -7342,6 +7365,38 @@
|
|
|
7342
7365
|
"items": {
|
|
7343
7366
|
"type": "object",
|
|
7344
7367
|
"anyOf": [
|
|
7368
|
+
{
|
|
7369
|
+
"properties": {
|
|
7370
|
+
"macroParameter": {
|
|
7371
|
+
"maxLength": 100,
|
|
7372
|
+
"type": "string",
|
|
7373
|
+
"fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
|
|
7374
|
+
},
|
|
7375
|
+
"type": {
|
|
7376
|
+
"enum": [
|
|
7377
|
+
"text",
|
|
7378
|
+
"TEXT"
|
|
7379
|
+
],
|
|
7380
|
+
"type": "string",
|
|
7381
|
+
"fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
|
|
7382
|
+
},
|
|
7383
|
+
"key": {
|
|
7384
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
7385
|
+
"maxLength": 100,
|
|
7386
|
+
"type": "string",
|
|
7387
|
+
"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"
|
|
7388
|
+
}
|
|
7389
|
+
},
|
|
7390
|
+
"required": [
|
|
7391
|
+
"macroParameter",
|
|
7392
|
+
"type",
|
|
7393
|
+
"key"
|
|
7394
|
+
],
|
|
7395
|
+
"shortClassName": "textControlBean",
|
|
7396
|
+
"type": "object",
|
|
7397
|
+
"title": "TextControl",
|
|
7398
|
+
"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"
|
|
7399
|
+
},
|
|
7345
7400
|
{
|
|
7346
7401
|
"properties": {
|
|
7347
7402
|
"controls": {
|
|
@@ -7400,35 +7455,72 @@
|
|
|
7400
7455
|
},
|
|
7401
7456
|
{
|
|
7402
7457
|
"properties": {
|
|
7458
|
+
"controls": {
|
|
7459
|
+
"items": {
|
|
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
|
+
},
|
|
7466
|
+
"label": {
|
|
7467
|
+
"$ref": "#/definitions/i18nProperty",
|
|
7468
|
+
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
7469
|
+
},
|
|
7470
|
+
"type": {
|
|
7471
|
+
"enum": [
|
|
7472
|
+
"togglebutton",
|
|
7473
|
+
"TOGGLEBUTTON"
|
|
7474
|
+
],
|
|
7475
|
+
"type": "string",
|
|
7476
|
+
"fieldDescription": "\n\nThe type field must be set to 'togglebutton'\n\n"
|
|
7477
|
+
},
|
|
7478
|
+
"key": {
|
|
7479
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
7480
|
+
"maxLength": 100,
|
|
7481
|
+
"type": "string",
|
|
7482
|
+
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
7483
|
+
}
|
|
7484
|
+
},
|
|
7485
|
+
"required": [
|
|
7486
|
+
"macroParameterValue",
|
|
7487
|
+
"label",
|
|
7488
|
+
"type",
|
|
7489
|
+
"key"
|
|
7490
|
+
],
|
|
7491
|
+
"additionalProperties": true,
|
|
7492
|
+
"shortClassName": "macroToggleButtonControlBean",
|
|
7493
|
+
"type": "object",
|
|
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"
|
|
7496
|
+
},
|
|
7497
|
+
"type": "array",
|
|
7498
|
+
"fieldDescription": "\n\nToggle buttons which will appear in the toggle group\n\n"
|
|
7499
|
+
},
|
|
7403
7500
|
"macroParameter": {
|
|
7501
|
+
"pattern": "[-_a-z0-9\\.]+",
|
|
7404
7502
|
"maxLength": 100,
|
|
7405
7503
|
"type": "string",
|
|
7406
|
-
"fieldDescription": "\n\nThe
|
|
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"
|
|
7407
7505
|
},
|
|
7408
7506
|
"type": {
|
|
7409
7507
|
"enum": [
|
|
7410
|
-
"
|
|
7411
|
-
"
|
|
7508
|
+
"togglegroup",
|
|
7509
|
+
"TOGGLEGROUP"
|
|
7412
7510
|
],
|
|
7413
7511
|
"type": "string",
|
|
7414
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
7415
|
-
},
|
|
7416
|
-
"key": {
|
|
7417
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
7418
|
-
"maxLength": 100,
|
|
7419
|
-
"type": "string",
|
|
7420
|
-
"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"
|
|
7512
|
+
"fieldDescription": "\n\nThe type field must be set to 'togglegroup'\n\n"
|
|
7421
7513
|
}
|
|
7422
7514
|
},
|
|
7423
7515
|
"required": [
|
|
7516
|
+
"controls",
|
|
7424
7517
|
"macroParameter",
|
|
7425
|
-
"type"
|
|
7426
|
-
"key"
|
|
7518
|
+
"type"
|
|
7427
7519
|
],
|
|
7428
|
-
"shortClassName": "
|
|
7520
|
+
"shortClassName": "macroToggleGroupBean",
|
|
7429
7521
|
"type": "object",
|
|
7430
|
-
"title": "
|
|
7431
|
-
"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"
|
|
7432
7524
|
},
|
|
7433
7525
|
{
|
|
7434
7526
|
"properties": {
|
|
@@ -7461,75 +7553,6 @@
|
|
|
7461
7553
|
"type": "object",
|
|
7462
7554
|
"title": "ButtonControl",
|
|
7463
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"
|
|
7464
|
-
},
|
|
7465
|
-
{
|
|
7466
|
-
"properties": {
|
|
7467
|
-
"controls": {
|
|
7468
|
-
"items": {
|
|
7469
|
-
"properties": {
|
|
7470
|
-
"macroParameterValue": {
|
|
7471
|
-
"maxLength": 10000,
|
|
7472
|
-
"type": "string",
|
|
7473
|
-
"fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n"
|
|
7474
|
-
},
|
|
7475
|
-
"label": {
|
|
7476
|
-
"$ref": "#/definitions/i18nProperty",
|
|
7477
|
-
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
7478
|
-
},
|
|
7479
|
-
"type": {
|
|
7480
|
-
"enum": [
|
|
7481
|
-
"togglebutton",
|
|
7482
|
-
"TOGGLEBUTTON"
|
|
7483
|
-
],
|
|
7484
|
-
"type": "string",
|
|
7485
|
-
"fieldDescription": "\n\nThe type field must be set to 'togglebutton'\n\n"
|
|
7486
|
-
},
|
|
7487
|
-
"key": {
|
|
7488
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
7489
|
-
"maxLength": 100,
|
|
7490
|
-
"type": "string",
|
|
7491
|
-
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
7492
|
-
}
|
|
7493
|
-
},
|
|
7494
|
-
"required": [
|
|
7495
|
-
"macroParameterValue",
|
|
7496
|
-
"label",
|
|
7497
|
-
"type",
|
|
7498
|
-
"key"
|
|
7499
|
-
],
|
|
7500
|
-
"additionalProperties": true,
|
|
7501
|
-
"shortClassName": "macroToggleButtonControlBean",
|
|
7502
|
-
"type": "object",
|
|
7503
|
-
"title": "ToggleButtonControl",
|
|
7504
|
-
"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"
|
|
7505
|
-
},
|
|
7506
|
-
"type": "array",
|
|
7507
|
-
"fieldDescription": "\n\nToggle buttons which will appear in the toggle group\n\n"
|
|
7508
|
-
},
|
|
7509
|
-
"macroParameter": {
|
|
7510
|
-
"pattern": "[-_a-z0-9\\.]+",
|
|
7511
|
-
"maxLength": 100,
|
|
7512
|
-
"type": "string",
|
|
7513
|
-
"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"
|
|
7514
|
-
},
|
|
7515
|
-
"type": {
|
|
7516
|
-
"enum": [
|
|
7517
|
-
"togglegroup",
|
|
7518
|
-
"TOGGLEGROUP"
|
|
7519
|
-
],
|
|
7520
|
-
"type": "string",
|
|
7521
|
-
"fieldDescription": "\n\nThe type field must be set to 'togglegroup'\n\n"
|
|
7522
|
-
}
|
|
7523
|
-
},
|
|
7524
|
-
"required": [
|
|
7525
|
-
"controls",
|
|
7526
|
-
"macroParameter",
|
|
7527
|
-
"type"
|
|
7528
|
-
],
|
|
7529
|
-
"shortClassName": "macroToggleGroupBean",
|
|
7530
|
-
"type": "object",
|
|
7531
|
-
"title": "ToggleGroup",
|
|
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"
|
|
7533
7556
|
}
|
|
7534
7557
|
]
|
|
7535
7558
|
},
|
|
@@ -7826,91 +7849,35 @@
|
|
|
7826
7849
|
"anyOf": [
|
|
7827
7850
|
{
|
|
7828
7851
|
"properties": {
|
|
7829
|
-
"
|
|
7830
|
-
"
|
|
7831
|
-
"properties": {
|
|
7832
|
-
"label": {
|
|
7833
|
-
"$ref": "#/definitions/i18nProperty",
|
|
7834
|
-
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
7835
|
-
},
|
|
7836
|
-
"type": {
|
|
7837
|
-
"enum": [
|
|
7838
|
-
"button",
|
|
7839
|
-
"BUTTON"
|
|
7840
|
-
],
|
|
7841
|
-
"type": "string",
|
|
7842
|
-
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
7843
|
-
},
|
|
7844
|
-
"key": {
|
|
7845
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
7846
|
-
"maxLength": 100,
|
|
7847
|
-
"type": "string",
|
|
7848
|
-
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
7849
|
-
}
|
|
7850
|
-
},
|
|
7851
|
-
"required": [
|
|
7852
|
-
"label",
|
|
7853
|
-
"type",
|
|
7854
|
-
"key"
|
|
7855
|
-
],
|
|
7856
|
-
"additionalProperties": true,
|
|
7857
|
-
"shortClassName": "buttonControlBean",
|
|
7858
|
-
"type": "object",
|
|
7859
|
-
"title": "ButtonControl",
|
|
7860
|
-
"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"
|
|
7861
|
-
},
|
|
7862
|
-
"type": "array",
|
|
7863
|
-
"fieldDescription": "\n\nControls which will appear in the control group\n\n"
|
|
7864
|
-
},
|
|
7865
|
-
"type": {
|
|
7866
|
-
"enum": [
|
|
7867
|
-
"group",
|
|
7868
|
-
"GROUP"
|
|
7869
|
-
],
|
|
7852
|
+
"macroParameter": {
|
|
7853
|
+
"maxLength": 100,
|
|
7870
7854
|
"type": "string",
|
|
7871
|
-
"fieldDescription": "\n\nThe
|
|
7872
|
-
}
|
|
7873
|
-
},
|
|
7874
|
-
"required": [
|
|
7875
|
-
"controls",
|
|
7876
|
-
"type"
|
|
7877
|
-
],
|
|
7878
|
-
"shortClassName": "controlGroupBean",
|
|
7879
|
-
"type": "object",
|
|
7880
|
-
"title": "ControlGroup",
|
|
7881
|
-
"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"
|
|
7882
|
-
},
|
|
7883
|
-
{
|
|
7884
|
-
"properties": {
|
|
7885
|
-
"label": {
|
|
7886
|
-
"$ref": "#/definitions/i18nProperty",
|
|
7887
|
-
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
7855
|
+
"fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
|
|
7888
7856
|
},
|
|
7889
7857
|
"type": {
|
|
7890
7858
|
"enum": [
|
|
7891
|
-
"
|
|
7892
|
-
"
|
|
7859
|
+
"text",
|
|
7860
|
+
"TEXT"
|
|
7893
7861
|
],
|
|
7894
7862
|
"type": "string",
|
|
7895
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
7863
|
+
"fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
|
|
7896
7864
|
},
|
|
7897
7865
|
"key": {
|
|
7898
7866
|
"pattern": "^[a-zA-Z0-9-]+$",
|
|
7899
7867
|
"maxLength": 100,
|
|
7900
7868
|
"type": "string",
|
|
7901
|
-
"fieldDescription": "\n\nA key to identify the
|
|
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"
|
|
7902
7870
|
}
|
|
7903
7871
|
},
|
|
7904
7872
|
"required": [
|
|
7905
|
-
"
|
|
7873
|
+
"macroParameter",
|
|
7906
7874
|
"type",
|
|
7907
7875
|
"key"
|
|
7908
7876
|
],
|
|
7909
|
-
"
|
|
7910
|
-
"shortClassName": "buttonControlBean",
|
|
7877
|
+
"shortClassName": "textControlBean",
|
|
7911
7878
|
"type": "object",
|
|
7912
|
-
"title": "
|
|
7913
|
-
"description": "\n\nDefines a
|
|
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"
|
|
7914
7881
|
},
|
|
7915
7882
|
{
|
|
7916
7883
|
"properties": {
|
|
@@ -7983,35 +7950,91 @@
|
|
|
7983
7950
|
},
|
|
7984
7951
|
{
|
|
7985
7952
|
"properties": {
|
|
7986
|
-
"
|
|
7987
|
-
"
|
|
7953
|
+
"controls": {
|
|
7954
|
+
"items": {
|
|
7955
|
+
"properties": {
|
|
7956
|
+
"label": {
|
|
7957
|
+
"$ref": "#/definitions/i18nProperty",
|
|
7958
|
+
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
7959
|
+
},
|
|
7960
|
+
"type": {
|
|
7961
|
+
"enum": [
|
|
7962
|
+
"button",
|
|
7963
|
+
"BUTTON"
|
|
7964
|
+
],
|
|
7965
|
+
"type": "string",
|
|
7966
|
+
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
7967
|
+
},
|
|
7968
|
+
"key": {
|
|
7969
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
7970
|
+
"maxLength": 100,
|
|
7971
|
+
"type": "string",
|
|
7972
|
+
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
7973
|
+
}
|
|
7974
|
+
},
|
|
7975
|
+
"required": [
|
|
7976
|
+
"label",
|
|
7977
|
+
"type",
|
|
7978
|
+
"key"
|
|
7979
|
+
],
|
|
7980
|
+
"additionalProperties": true,
|
|
7981
|
+
"shortClassName": "buttonControlBean",
|
|
7982
|
+
"type": "object",
|
|
7983
|
+
"title": "ButtonControl",
|
|
7984
|
+
"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"
|
|
7985
|
+
},
|
|
7986
|
+
"type": "array",
|
|
7987
|
+
"fieldDescription": "\n\nControls which will appear in the control group\n\n"
|
|
7988
|
+
},
|
|
7989
|
+
"type": {
|
|
7990
|
+
"enum": [
|
|
7991
|
+
"group",
|
|
7992
|
+
"GROUP"
|
|
7993
|
+
],
|
|
7988
7994
|
"type": "string",
|
|
7989
|
-
"fieldDescription": "\n\nThe
|
|
7995
|
+
"fieldDescription": "\n\nThe type field must be set to 'group'\n\n"
|
|
7996
|
+
}
|
|
7997
|
+
},
|
|
7998
|
+
"required": [
|
|
7999
|
+
"controls",
|
|
8000
|
+
"type"
|
|
8001
|
+
],
|
|
8002
|
+
"shortClassName": "controlGroupBean",
|
|
8003
|
+
"type": "object",
|
|
8004
|
+
"title": "ControlGroup",
|
|
8005
|
+
"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"
|
|
8006
|
+
},
|
|
8007
|
+
{
|
|
8008
|
+
"properties": {
|
|
8009
|
+
"label": {
|
|
8010
|
+
"$ref": "#/definitions/i18nProperty",
|
|
8011
|
+
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
7990
8012
|
},
|
|
7991
8013
|
"type": {
|
|
7992
8014
|
"enum": [
|
|
7993
|
-
"
|
|
7994
|
-
"
|
|
8015
|
+
"button",
|
|
8016
|
+
"BUTTON"
|
|
7995
8017
|
],
|
|
7996
8018
|
"type": "string",
|
|
7997
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
8019
|
+
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
7998
8020
|
},
|
|
7999
8021
|
"key": {
|
|
8000
8022
|
"pattern": "^[a-zA-Z0-9-]+$",
|
|
8001
8023
|
"maxLength": 100,
|
|
8002
8024
|
"type": "string",
|
|
8003
|
-
"fieldDescription": "\n\nA key to identify
|
|
8025
|
+
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
8004
8026
|
}
|
|
8005
8027
|
},
|
|
8006
8028
|
"required": [
|
|
8007
|
-
"
|
|
8029
|
+
"label",
|
|
8008
8030
|
"type",
|
|
8009
8031
|
"key"
|
|
8010
8032
|
],
|
|
8011
|
-
"
|
|
8033
|
+
"additionalProperties": true,
|
|
8034
|
+
"shortClassName": "buttonControlBean",
|
|
8012
8035
|
"type": "object",
|
|
8013
|
-
"title": "
|
|
8014
|
-
"description": "\n\nDefines a
|
|
8036
|
+
"title": "ButtonControl",
|
|
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"
|
|
8015
8038
|
}
|
|
8016
8039
|
]
|
|
8017
8040
|
},
|
|
@@ -8247,6 +8270,51 @@
|
|
|
8247
8270
|
"type": "object",
|
|
8248
8271
|
"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
8272
|
"anyOf": [
|
|
8273
|
+
{
|
|
8274
|
+
"properties": {
|
|
8275
|
+
"size": {
|
|
8276
|
+
"enum": [
|
|
8277
|
+
"small",
|
|
8278
|
+
"SMALL",
|
|
8279
|
+
"medium",
|
|
8280
|
+
"MEDIUM",
|
|
8281
|
+
"large",
|
|
8282
|
+
"LARGE",
|
|
8283
|
+
"x-large",
|
|
8284
|
+
"X-LARGE",
|
|
8285
|
+
"fullscreen",
|
|
8286
|
+
"FULLSCREEN",
|
|
8287
|
+
"maximum",
|
|
8288
|
+
"MAXIMUM"
|
|
8289
|
+
],
|
|
8290
|
+
"type": "string",
|
|
8291
|
+
"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"
|
|
8292
|
+
},
|
|
8293
|
+
"chrome": {
|
|
8294
|
+
"type": "boolean",
|
|
8295
|
+
"fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
|
|
8296
|
+
"defaultValue": "true"
|
|
8297
|
+
},
|
|
8298
|
+
"width": {
|
|
8299
|
+
"maxLength": 10,
|
|
8300
|
+
"type": "string",
|
|
8301
|
+
"fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
|
|
8302
|
+
},
|
|
8303
|
+
"header": {
|
|
8304
|
+
"$ref": "#/definitions/i18nProperty",
|
|
8305
|
+
"fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
|
|
8306
|
+
},
|
|
8307
|
+
"height": {
|
|
8308
|
+
"maxLength": 10,
|
|
8309
|
+
"type": "string",
|
|
8310
|
+
"fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
|
|
8311
|
+
}
|
|
8312
|
+
},
|
|
8313
|
+
"shortClassName": "dialogOptions",
|
|
8314
|
+
"type": "object",
|
|
8315
|
+
"title": "Dialog Options",
|
|
8316
|
+
"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"
|
|
8317
|
+
},
|
|
8250
8318
|
{
|
|
8251
8319
|
"properties": {
|
|
8252
8320
|
"offsetX": {
|
|
@@ -8294,51 +8362,6 @@
|
|
|
8294
8362
|
"title": "Inline Dialog Options",
|
|
8295
8363
|
"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"
|
|
8296
8364
|
},
|
|
8297
|
-
{
|
|
8298
|
-
"properties": {
|
|
8299
|
-
"size": {
|
|
8300
|
-
"enum": [
|
|
8301
|
-
"small",
|
|
8302
|
-
"SMALL",
|
|
8303
|
-
"medium",
|
|
8304
|
-
"MEDIUM",
|
|
8305
|
-
"large",
|
|
8306
|
-
"LARGE",
|
|
8307
|
-
"x-large",
|
|
8308
|
-
"X-LARGE",
|
|
8309
|
-
"fullscreen",
|
|
8310
|
-
"FULLSCREEN",
|
|
8311
|
-
"maximum",
|
|
8312
|
-
"MAXIMUM"
|
|
8313
|
-
],
|
|
8314
|
-
"type": "string",
|
|
8315
|
-
"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"
|
|
8316
|
-
},
|
|
8317
|
-
"chrome": {
|
|
8318
|
-
"type": "boolean",
|
|
8319
|
-
"fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
|
|
8320
|
-
"defaultValue": "true"
|
|
8321
|
-
},
|
|
8322
|
-
"width": {
|
|
8323
|
-
"maxLength": 10,
|
|
8324
|
-
"type": "string",
|
|
8325
|
-
"fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
|
|
8326
|
-
},
|
|
8327
|
-
"header": {
|
|
8328
|
-
"$ref": "#/definitions/i18nProperty",
|
|
8329
|
-
"fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
|
|
8330
|
-
},
|
|
8331
|
-
"height": {
|
|
8332
|
-
"maxLength": 10,
|
|
8333
|
-
"type": "string",
|
|
8334
|
-
"fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
|
|
8335
|
-
}
|
|
8336
|
-
},
|
|
8337
|
-
"shortClassName": "dialogOptions",
|
|
8338
|
-
"type": "object",
|
|
8339
|
-
"title": "Dialog Options",
|
|
8340
|
-
"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"
|
|
8341
|
-
},
|
|
8342
8365
|
{
|
|
8343
8366
|
"properties": {
|
|
8344
8367
|
"key": {
|
|
@@ -8768,6 +8791,41 @@
|
|
|
8768
8791
|
},
|
|
8769
8792
|
"baseUrl": {
|
|
8770
8793
|
"type": "string"
|
|
8794
|
+
},
|
|
8795
|
+
"operations": {
|
|
8796
|
+
"description": "The type of operations done in the remote",
|
|
8797
|
+
"type": "array",
|
|
8798
|
+
"items": {
|
|
8799
|
+
"type": "string",
|
|
8800
|
+
"enum": [
|
|
8801
|
+
"storage",
|
|
8802
|
+
"other"
|
|
8803
|
+
]
|
|
8804
|
+
},
|
|
8805
|
+
"minItems": 1
|
|
8806
|
+
},
|
|
8807
|
+
"storage": {
|
|
8808
|
+
"description": "Options related to remote storage",
|
|
8809
|
+
"type": "object",
|
|
8810
|
+
"required": [
|
|
8811
|
+
"classifications"
|
|
8812
|
+
],
|
|
8813
|
+
"additionalProperties": false,
|
|
8814
|
+
"properties": {
|
|
8815
|
+
"classifications": {
|
|
8816
|
+
"description": "Labels to classify the type of data stored",
|
|
8817
|
+
"type": "array",
|
|
8818
|
+
"items": {
|
|
8819
|
+
"type": "string",
|
|
8820
|
+
"enum": [
|
|
8821
|
+
"ugc",
|
|
8822
|
+
"pii",
|
|
8823
|
+
"other"
|
|
8824
|
+
]
|
|
8825
|
+
},
|
|
8826
|
+
"minItems": 1
|
|
8827
|
+
}
|
|
8828
|
+
}
|
|
8771
8829
|
}
|
|
8772
8830
|
}
|
|
8773
8831
|
}
|
|
@@ -9651,10 +9709,10 @@
|
|
|
9651
9709
|
"type": "object",
|
|
9652
9710
|
"anyOf": [
|
|
9653
9711
|
{
|
|
9654
|
-
"$ref": "
|
|
9712
|
+
"$ref": "#"
|
|
9655
9713
|
},
|
|
9656
9714
|
{
|
|
9657
|
-
"$ref": "
|
|
9715
|
+
"$ref": "#/definitions/singleCondition"
|
|
9658
9716
|
}
|
|
9659
9717
|
]
|
|
9660
9718
|
},
|