@forge/manifest 4.5.0 → 4.5.1
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 +12 -0
- package/out/schema/manifest-schema.json +257 -267
- package/out/schema/manifest.d.ts +279 -279
- package/package.json +1 -1
|
@@ -7315,7 +7315,6 @@
|
|
|
7315
7315
|
"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"
|
|
7316
7316
|
},
|
|
7317
7317
|
"url": {
|
|
7318
|
-
"format": "uri",
|
|
7319
7318
|
"type": "string",
|
|
7320
7319
|
"fieldDescription": "\n\nThe url to retrieve the content from.\n This must be relative to the add-on's baseUrl.\n\n"
|
|
7321
7320
|
},
|
|
@@ -7369,10 +7368,10 @@
|
|
|
7369
7368
|
"type": "object",
|
|
7370
7369
|
"anyOf": [
|
|
7371
7370
|
{
|
|
7372
|
-
"$ref": "#/definitions/
|
|
7371
|
+
"$ref": "#/definitions/compositeCondition"
|
|
7373
7372
|
},
|
|
7374
7373
|
{
|
|
7375
|
-
"$ref": "#/definitions/
|
|
7374
|
+
"$ref": "#/definitions/singleCondition"
|
|
7376
7375
|
}
|
|
7377
7376
|
]
|
|
7378
7377
|
},
|
|
@@ -7386,7 +7385,6 @@
|
|
|
7386
7385
|
"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"
|
|
7387
7386
|
},
|
|
7388
7387
|
"url": {
|
|
7389
|
-
"format": "uri",
|
|
7390
7388
|
"type": "string",
|
|
7391
7389
|
"fieldDescription": "\n\nThe URL of the add-on resource that provides the web panel content. This URL must be relative to the add-on's \n baseUrl and can use <a href=\"../../context-parameters/\">context parameters</a>.\n\n"
|
|
7392
7390
|
},
|
|
@@ -7487,10 +7485,10 @@
|
|
|
7487
7485
|
"type": "object",
|
|
7488
7486
|
"anyOf": [
|
|
7489
7487
|
{
|
|
7490
|
-
"$ref": "#/definitions/
|
|
7488
|
+
"$ref": "#/definitions/singleCondition"
|
|
7491
7489
|
},
|
|
7492
7490
|
{
|
|
7493
|
-
"$ref": "#/definitions/
|
|
7491
|
+
"$ref": "#/definitions/compositeCondition"
|
|
7494
7492
|
}
|
|
7495
7493
|
]
|
|
7496
7494
|
},
|
|
@@ -7504,7 +7502,6 @@
|
|
|
7504
7502
|
"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"
|
|
7505
7503
|
},
|
|
7506
7504
|
"url": {
|
|
7507
|
-
"format": "uri",
|
|
7508
7505
|
"type": "string",
|
|
7509
7506
|
"fieldDescription": "\n\nThe url to retrieve the content from.\n This must be relative to the add-on's baseUrl.\n\n"
|
|
7510
7507
|
},
|
|
@@ -7545,10 +7542,10 @@
|
|
|
7545
7542
|
"type": "object",
|
|
7546
7543
|
"anyOf": [
|
|
7547
7544
|
{
|
|
7548
|
-
"$ref": "#/definitions/
|
|
7545
|
+
"$ref": "#/definitions/singleCondition"
|
|
7549
7546
|
},
|
|
7550
7547
|
{
|
|
7551
|
-
"$ref": "#/definitions/
|
|
7548
|
+
"$ref": "#/definitions/compositeCondition"
|
|
7552
7549
|
}
|
|
7553
7550
|
]
|
|
7554
7551
|
},
|
|
@@ -7603,10 +7600,10 @@
|
|
|
7603
7600
|
"type": "object",
|
|
7604
7601
|
"anyOf": [
|
|
7605
7602
|
{
|
|
7606
|
-
"$ref": "#/definitions/
|
|
7603
|
+
"$ref": "#/definitions/singleCondition"
|
|
7607
7604
|
},
|
|
7608
7605
|
{
|
|
7609
|
-
"$ref": "#/definitions/
|
|
7606
|
+
"$ref": "#/definitions/compositeCondition"
|
|
7610
7607
|
}
|
|
7611
7608
|
]
|
|
7612
7609
|
},
|
|
@@ -7620,7 +7617,6 @@
|
|
|
7620
7617
|
"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"
|
|
7621
7618
|
},
|
|
7622
7619
|
"url": {
|
|
7623
|
-
"format": "uri",
|
|
7624
7620
|
"type": "string",
|
|
7625
7621
|
"fieldDescription": "\n\nThe url to retrieve the content from.\n This must be relative to the add-on's baseUrl.\n\n"
|
|
7626
7622
|
},
|
|
@@ -7818,7 +7814,7 @@
|
|
|
7818
7814
|
"PRODUCT"
|
|
7819
7815
|
],
|
|
7820
7816
|
"type": "string",
|
|
7821
|
-
"fieldDescription": "\n\nThe context for the URL parameter. Not applicable if an absolute URL is specified. Possible values\n <ul>\n <li
|
|
7817
|
+
"fieldDescription": "\n\nThe context for the URL parameter. Not applicable if an absolute URL is specified. Possible values\n <ul>\n <li>`addon` - a URL relative to the add-on's base URL</li>\n <li>`page` - targets a Page module by specifying the Page's module key as the URL</li>\n <li>`product` - a URL relative to the product's base URL</li>\n </ul>\n\n",
|
|
7822
7818
|
"defaultValue": "addon"
|
|
7823
7819
|
},
|
|
7824
7820
|
"name": {
|
|
@@ -7839,33 +7835,6 @@
|
|
|
7839
7835
|
"items": {
|
|
7840
7836
|
"type": "object",
|
|
7841
7837
|
"anyOf": [
|
|
7842
|
-
{
|
|
7843
|
-
"properties": {
|
|
7844
|
-
"condition": {
|
|
7845
|
-
"maxLength": 100,
|
|
7846
|
-
"type": "string",
|
|
7847
|
-
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
7848
|
-
},
|
|
7849
|
-
"invert": {
|
|
7850
|
-
"type": "boolean",
|
|
7851
|
-
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
7852
|
-
"defaultValue": "false"
|
|
7853
|
-
},
|
|
7854
|
-
"params": {
|
|
7855
|
-
"additionalProperties": true,
|
|
7856
|
-
"type": "object",
|
|
7857
|
-
"fieldTitle": "Object",
|
|
7858
|
-
"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"
|
|
7859
|
-
}
|
|
7860
|
-
},
|
|
7861
|
-
"required": [
|
|
7862
|
-
"condition"
|
|
7863
|
-
],
|
|
7864
|
-
"shortClassName": "singleConditionBean",
|
|
7865
|
-
"type": "object",
|
|
7866
|
-
"title": "Single Condition",
|
|
7867
|
-
"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"
|
|
7868
|
-
},
|
|
7869
7838
|
{
|
|
7870
7839
|
"properties": {
|
|
7871
7840
|
"conditions": {
|
|
@@ -7928,6 +7897,33 @@
|
|
|
7928
7897
|
"type": "object",
|
|
7929
7898
|
"title": "Composite Condition",
|
|
7930
7899
|
"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"
|
|
7900
|
+
},
|
|
7901
|
+
{
|
|
7902
|
+
"properties": {
|
|
7903
|
+
"condition": {
|
|
7904
|
+
"maxLength": 100,
|
|
7905
|
+
"type": "string",
|
|
7906
|
+
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
7907
|
+
},
|
|
7908
|
+
"invert": {
|
|
7909
|
+
"type": "boolean",
|
|
7910
|
+
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
7911
|
+
"defaultValue": "false"
|
|
7912
|
+
},
|
|
7913
|
+
"params": {
|
|
7914
|
+
"additionalProperties": true,
|
|
7915
|
+
"type": "object",
|
|
7916
|
+
"fieldTitle": "Object",
|
|
7917
|
+
"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"
|
|
7918
|
+
}
|
|
7919
|
+
},
|
|
7920
|
+
"required": [
|
|
7921
|
+
"condition"
|
|
7922
|
+
],
|
|
7923
|
+
"shortClassName": "singleConditionBean",
|
|
7924
|
+
"type": "object",
|
|
7925
|
+
"title": "Single Condition",
|
|
7926
|
+
"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"
|
|
7931
7927
|
}
|
|
7932
7928
|
]
|
|
7933
7929
|
},
|
|
@@ -7998,7 +7994,6 @@
|
|
|
7998
7994
|
"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"
|
|
7999
7995
|
},
|
|
8000
7996
|
"url": {
|
|
8001
|
-
"format": "uri",
|
|
8002
7997
|
"type": "string",
|
|
8003
7998
|
"fieldDescription": "\n\nThe url to retrieve the content from.\n This must be relative to the add-on's baseUrl.\n\n"
|
|
8004
7999
|
},
|
|
@@ -8245,10 +8240,10 @@
|
|
|
8245
8240
|
"type": "object",
|
|
8246
8241
|
"anyOf": [
|
|
8247
8242
|
{
|
|
8248
|
-
"$ref": "#/definitions/
|
|
8243
|
+
"$ref": "#/definitions/compositeCondition"
|
|
8249
8244
|
},
|
|
8250
8245
|
{
|
|
8251
|
-
"$ref": "#/definitions/
|
|
8246
|
+
"$ref": "#/definitions/singleCondition"
|
|
8252
8247
|
}
|
|
8253
8248
|
]
|
|
8254
8249
|
},
|
|
@@ -8435,15 +8430,39 @@
|
|
|
8435
8430
|
"items": {
|
|
8436
8431
|
"type": "object",
|
|
8437
8432
|
"anyOf": [
|
|
8433
|
+
{
|
|
8434
|
+
"properties": {
|
|
8435
|
+
"condition": {
|
|
8436
|
+
"maxLength": 100,
|
|
8437
|
+
"type": "string",
|
|
8438
|
+
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
8439
|
+
},
|
|
8440
|
+
"invert": {
|
|
8441
|
+
"type": "boolean",
|
|
8442
|
+
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
8443
|
+
"defaultValue": "false"
|
|
8444
|
+
},
|
|
8445
|
+
"params": {
|
|
8446
|
+
"additionalProperties": true,
|
|
8447
|
+
"type": "object",
|
|
8448
|
+
"fieldTitle": "Object",
|
|
8449
|
+
"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"
|
|
8450
|
+
}
|
|
8451
|
+
},
|
|
8452
|
+
"required": [
|
|
8453
|
+
"condition"
|
|
8454
|
+
],
|
|
8455
|
+
"shortClassName": "singleConditionBean",
|
|
8456
|
+
"type": "object",
|
|
8457
|
+
"title": "Single Condition",
|
|
8458
|
+
"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"
|
|
8459
|
+
},
|
|
8438
8460
|
{
|
|
8439
8461
|
"properties": {
|
|
8440
8462
|
"conditions": {
|
|
8441
8463
|
"items": {
|
|
8442
8464
|
"type": "object",
|
|
8443
8465
|
"anyOf": [
|
|
8444
|
-
{
|
|
8445
|
-
"$ref": "#/definitions/singleCondition"
|
|
8446
|
-
},
|
|
8447
8466
|
{
|
|
8448
8467
|
"properties": {
|
|
8449
8468
|
"conditions": {
|
|
@@ -8451,10 +8470,10 @@
|
|
|
8451
8470
|
"type": "object",
|
|
8452
8471
|
"anyOf": [
|
|
8453
8472
|
{
|
|
8454
|
-
"$ref": "
|
|
8473
|
+
"$ref": "#"
|
|
8455
8474
|
},
|
|
8456
8475
|
{
|
|
8457
|
-
"$ref": "
|
|
8476
|
+
"$ref": "#/definitions/singleCondition"
|
|
8458
8477
|
}
|
|
8459
8478
|
]
|
|
8460
8479
|
},
|
|
@@ -8476,6 +8495,9 @@
|
|
|
8476
8495
|
"type": "object",
|
|
8477
8496
|
"title": "Composite Condition",
|
|
8478
8497
|
"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"
|
|
8498
|
+
},
|
|
8499
|
+
{
|
|
8500
|
+
"$ref": "#/definitions/singleCondition"
|
|
8479
8501
|
}
|
|
8480
8502
|
]
|
|
8481
8503
|
},
|
|
@@ -8497,33 +8519,6 @@
|
|
|
8497
8519
|
"type": "object",
|
|
8498
8520
|
"title": "Composite Condition",
|
|
8499
8521
|
"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"
|
|
8500
|
-
},
|
|
8501
|
-
{
|
|
8502
|
-
"properties": {
|
|
8503
|
-
"condition": {
|
|
8504
|
-
"maxLength": 100,
|
|
8505
|
-
"type": "string",
|
|
8506
|
-
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
8507
|
-
},
|
|
8508
|
-
"invert": {
|
|
8509
|
-
"type": "boolean",
|
|
8510
|
-
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
8511
|
-
"defaultValue": "false"
|
|
8512
|
-
},
|
|
8513
|
-
"params": {
|
|
8514
|
-
"additionalProperties": true,
|
|
8515
|
-
"type": "object",
|
|
8516
|
-
"fieldTitle": "Object",
|
|
8517
|
-
"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"
|
|
8518
|
-
}
|
|
8519
|
-
},
|
|
8520
|
-
"required": [
|
|
8521
|
-
"condition"
|
|
8522
|
-
],
|
|
8523
|
-
"shortClassName": "singleConditionBean",
|
|
8524
|
-
"type": "object",
|
|
8525
|
-
"title": "Single Condition",
|
|
8526
|
-
"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"
|
|
8527
8522
|
}
|
|
8528
8523
|
]
|
|
8529
8524
|
},
|
|
@@ -8784,7 +8779,7 @@
|
|
|
8784
8779
|
"properties": {
|
|
8785
8780
|
"location": {
|
|
8786
8781
|
"type": "object",
|
|
8787
|
-
"fieldDescription": "\n\nSpecifies where the background script will be located inside Jira, and any location-specific configuration.\n Currently, a background script can only be located in the new issue view and on the dashboards.\n\n Read about [Issue Background Script Location](/cloud/jira/platform/modules/issue-background-script-location/).\n\n",
|
|
8782
|
+
"fieldDescription": "\n\nSpecifies where the background script will be located inside Jira, and any location-specific configuration.\n Currently, a background script can only be located in the new issue view and on the dashboards.\n\n Read about [Issue Background Script Location](/cloud/jira/platform/modules/issue-background-script-location/).\n Read about [Dashboard Background Script Location](/cloud/jira/platform/modules/dashboard-background-script-location/).\n\n",
|
|
8788
8783
|
"anyOf": [
|
|
8789
8784
|
{
|
|
8790
8785
|
"properties": {
|
|
@@ -8796,16 +8791,20 @@
|
|
|
8796
8791
|
"DASHBOARD"
|
|
8797
8792
|
],
|
|
8798
8793
|
"type": "string",
|
|
8799
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
8794
|
+
"fieldDescription": "\n\nThe type field must be set to 'issue-view'\n\n"
|
|
8795
|
+
},
|
|
8796
|
+
"shouldReloadOnRefresh": {
|
|
8797
|
+
"type": "boolean",
|
|
8798
|
+
"fieldDescription": "\n\nWhether the background script iframe should reload when the issue is refreshed.\n\n"
|
|
8800
8799
|
}
|
|
8801
8800
|
},
|
|
8802
8801
|
"required": [
|
|
8803
8802
|
"type"
|
|
8804
8803
|
],
|
|
8805
|
-
"shortClassName": "
|
|
8804
|
+
"shortClassName": "issueViewBackgroundScriptLocationBean",
|
|
8806
8805
|
"type": "object",
|
|
8807
|
-
"title": "
|
|
8808
|
-
"description": "\n\nDescribes the location of the
|
|
8806
|
+
"title": "Issue Background Script Location",
|
|
8807
|
+
"description": "\n\nDescribes the location of the issue background script module.\n\n"
|
|
8809
8808
|
},
|
|
8810
8809
|
{
|
|
8811
8810
|
"properties": {
|
|
@@ -8817,20 +8816,16 @@
|
|
|
8817
8816
|
"DASHBOARD"
|
|
8818
8817
|
],
|
|
8819
8818
|
"type": "string",
|
|
8820
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
8821
|
-
},
|
|
8822
|
-
"shouldReloadOnRefresh": {
|
|
8823
|
-
"type": "boolean",
|
|
8824
|
-
"fieldDescription": "\n\nWhether the background script iframe should reload when the issue is refreshed.\n\n"
|
|
8819
|
+
"fieldDescription": "\n\nThe type field must be set to 'dashboard'\n\n"
|
|
8825
8820
|
}
|
|
8826
8821
|
},
|
|
8827
8822
|
"required": [
|
|
8828
8823
|
"type"
|
|
8829
8824
|
],
|
|
8830
|
-
"shortClassName": "
|
|
8825
|
+
"shortClassName": "dashboardBackgroundScriptLocationBean",
|
|
8831
8826
|
"type": "object",
|
|
8832
|
-
"title": "
|
|
8833
|
-
"description": "\n\nDescribes the location of the
|
|
8827
|
+
"title": "Dashboard Background Script Location",
|
|
8828
|
+
"description": "\n\nDescribes the location of the dashboard background script module.\n\n"
|
|
8834
8829
|
}
|
|
8835
8830
|
]
|
|
8836
8831
|
},
|
|
@@ -8966,10 +8961,10 @@
|
|
|
8966
8961
|
"type": "object",
|
|
8967
8962
|
"anyOf": [
|
|
8968
8963
|
{
|
|
8969
|
-
"$ref": "#/definitions/
|
|
8964
|
+
"$ref": "#/definitions/compositeCondition"
|
|
8970
8965
|
},
|
|
8971
8966
|
{
|
|
8972
|
-
"$ref": "#/definitions/
|
|
8967
|
+
"$ref": "#/definitions/singleCondition"
|
|
8973
8968
|
}
|
|
8974
8969
|
]
|
|
8975
8970
|
},
|
|
@@ -9101,10 +9096,10 @@
|
|
|
9101
9096
|
"type": "object",
|
|
9102
9097
|
"anyOf": [
|
|
9103
9098
|
{
|
|
9104
|
-
"$ref": "#/definitions/
|
|
9099
|
+
"$ref": "#/definitions/singleCondition"
|
|
9105
9100
|
},
|
|
9106
9101
|
{
|
|
9107
|
-
"$ref": "#/definitions/
|
|
9102
|
+
"$ref": "#/definitions/compositeCondition"
|
|
9108
9103
|
}
|
|
9109
9104
|
]
|
|
9110
9105
|
},
|
|
@@ -9191,15 +9186,39 @@
|
|
|
9191
9186
|
"items": {
|
|
9192
9187
|
"type": "object",
|
|
9193
9188
|
"anyOf": [
|
|
9189
|
+
{
|
|
9190
|
+
"properties": {
|
|
9191
|
+
"condition": {
|
|
9192
|
+
"maxLength": 100,
|
|
9193
|
+
"type": "string",
|
|
9194
|
+
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
9195
|
+
},
|
|
9196
|
+
"invert": {
|
|
9197
|
+
"type": "boolean",
|
|
9198
|
+
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
9199
|
+
"defaultValue": "false"
|
|
9200
|
+
},
|
|
9201
|
+
"params": {
|
|
9202
|
+
"additionalProperties": true,
|
|
9203
|
+
"type": "object",
|
|
9204
|
+
"fieldTitle": "Object",
|
|
9205
|
+
"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"
|
|
9206
|
+
}
|
|
9207
|
+
},
|
|
9208
|
+
"required": [
|
|
9209
|
+
"condition"
|
|
9210
|
+
],
|
|
9211
|
+
"shortClassName": "singleConditionBean",
|
|
9212
|
+
"type": "object",
|
|
9213
|
+
"title": "Single Condition",
|
|
9214
|
+
"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"
|
|
9215
|
+
},
|
|
9194
9216
|
{
|
|
9195
9217
|
"properties": {
|
|
9196
9218
|
"conditions": {
|
|
9197
9219
|
"items": {
|
|
9198
9220
|
"type": "object",
|
|
9199
9221
|
"anyOf": [
|
|
9200
|
-
{
|
|
9201
|
-
"$ref": "#/definitions/singleCondition"
|
|
9202
|
-
},
|
|
9203
9222
|
{
|
|
9204
9223
|
"properties": {
|
|
9205
9224
|
"conditions": {
|
|
@@ -9207,10 +9226,10 @@
|
|
|
9207
9226
|
"type": "object",
|
|
9208
9227
|
"anyOf": [
|
|
9209
9228
|
{
|
|
9210
|
-
"$ref": "
|
|
9229
|
+
"$ref": "#"
|
|
9211
9230
|
},
|
|
9212
9231
|
{
|
|
9213
|
-
"$ref": "
|
|
9232
|
+
"$ref": "#/definitions/singleCondition"
|
|
9214
9233
|
}
|
|
9215
9234
|
]
|
|
9216
9235
|
},
|
|
@@ -9232,6 +9251,9 @@
|
|
|
9232
9251
|
"type": "object",
|
|
9233
9252
|
"title": "Composite Condition",
|
|
9234
9253
|
"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"
|
|
9254
|
+
},
|
|
9255
|
+
{
|
|
9256
|
+
"$ref": "#/definitions/singleCondition"
|
|
9235
9257
|
}
|
|
9236
9258
|
]
|
|
9237
9259
|
},
|
|
@@ -9253,33 +9275,6 @@
|
|
|
9253
9275
|
"type": "object",
|
|
9254
9276
|
"title": "Composite Condition",
|
|
9255
9277
|
"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"
|
|
9256
|
-
},
|
|
9257
|
-
{
|
|
9258
|
-
"properties": {
|
|
9259
|
-
"condition": {
|
|
9260
|
-
"maxLength": 100,
|
|
9261
|
-
"type": "string",
|
|
9262
|
-
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
9263
|
-
},
|
|
9264
|
-
"invert": {
|
|
9265
|
-
"type": "boolean",
|
|
9266
|
-
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
9267
|
-
"defaultValue": "false"
|
|
9268
|
-
},
|
|
9269
|
-
"params": {
|
|
9270
|
-
"additionalProperties": true,
|
|
9271
|
-
"type": "object",
|
|
9272
|
-
"fieldTitle": "Object",
|
|
9273
|
-
"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"
|
|
9274
|
-
}
|
|
9275
|
-
},
|
|
9276
|
-
"required": [
|
|
9277
|
-
"condition"
|
|
9278
|
-
],
|
|
9279
|
-
"shortClassName": "singleConditionBean",
|
|
9280
|
-
"type": "object",
|
|
9281
|
-
"title": "Single Condition",
|
|
9282
|
-
"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"
|
|
9283
9278
|
}
|
|
9284
9279
|
]
|
|
9285
9280
|
},
|
|
@@ -9692,7 +9687,6 @@
|
|
|
9692
9687
|
"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"
|
|
9693
9688
|
},
|
|
9694
9689
|
"url": {
|
|
9695
|
-
"format": "uri",
|
|
9696
9690
|
"type": "string",
|
|
9697
9691
|
"fieldDescription": "\n\nThe url to retrieve the content from.\n This must be relative to the add-on's baseUrl.\n\n"
|
|
9698
9692
|
},
|
|
@@ -9746,10 +9740,10 @@
|
|
|
9746
9740
|
"type": "object",
|
|
9747
9741
|
"anyOf": [
|
|
9748
9742
|
{
|
|
9749
|
-
"$ref": "#/definitions/
|
|
9743
|
+
"$ref": "#/definitions/compositeCondition"
|
|
9750
9744
|
},
|
|
9751
9745
|
{
|
|
9752
|
-
"$ref": "#/definitions/
|
|
9746
|
+
"$ref": "#/definitions/singleCondition"
|
|
9753
9747
|
}
|
|
9754
9748
|
]
|
|
9755
9749
|
},
|
|
@@ -9763,7 +9757,6 @@
|
|
|
9763
9757
|
"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"
|
|
9764
9758
|
},
|
|
9765
9759
|
"url": {
|
|
9766
|
-
"format": "uri",
|
|
9767
9760
|
"type": "string",
|
|
9768
9761
|
"fieldDescription": "\n\nThe URL of the add-on resource that provides the web panel content. This URL must be relative to the add-on's \n baseUrl and can use <a href=\"../../context-parameters/\">context parameters</a>.\n\n"
|
|
9769
9762
|
},
|
|
@@ -9864,10 +9857,10 @@
|
|
|
9864
9857
|
"type": "object",
|
|
9865
9858
|
"anyOf": [
|
|
9866
9859
|
{
|
|
9867
|
-
"$ref": "#/definitions/
|
|
9860
|
+
"$ref": "#/definitions/singleCondition"
|
|
9868
9861
|
},
|
|
9869
9862
|
{
|
|
9870
|
-
"$ref": "#/definitions/
|
|
9863
|
+
"$ref": "#/definitions/compositeCondition"
|
|
9871
9864
|
}
|
|
9872
9865
|
]
|
|
9873
9866
|
},
|
|
@@ -9881,7 +9874,6 @@
|
|
|
9881
9874
|
"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"
|
|
9882
9875
|
},
|
|
9883
9876
|
"url": {
|
|
9884
|
-
"format": "uri",
|
|
9885
9877
|
"type": "string",
|
|
9886
9878
|
"fieldDescription": "\n\nThe url to retrieve the content from.\n This must be relative to the add-on's baseUrl.\n\n"
|
|
9887
9879
|
},
|
|
@@ -9922,10 +9914,10 @@
|
|
|
9922
9914
|
"type": "object",
|
|
9923
9915
|
"anyOf": [
|
|
9924
9916
|
{
|
|
9925
|
-
"$ref": "#/definitions/
|
|
9917
|
+
"$ref": "#/definitions/singleCondition"
|
|
9926
9918
|
},
|
|
9927
9919
|
{
|
|
9928
|
-
"$ref": "#/definitions/
|
|
9920
|
+
"$ref": "#/definitions/compositeCondition"
|
|
9929
9921
|
}
|
|
9930
9922
|
]
|
|
9931
9923
|
},
|
|
@@ -9980,10 +9972,10 @@
|
|
|
9980
9972
|
"type": "object",
|
|
9981
9973
|
"anyOf": [
|
|
9982
9974
|
{
|
|
9983
|
-
"$ref": "#/definitions/
|
|
9975
|
+
"$ref": "#/definitions/singleCondition"
|
|
9984
9976
|
},
|
|
9985
9977
|
{
|
|
9986
|
-
"$ref": "#/definitions/
|
|
9978
|
+
"$ref": "#/definitions/compositeCondition"
|
|
9987
9979
|
}
|
|
9988
9980
|
]
|
|
9989
9981
|
},
|
|
@@ -9997,7 +9989,6 @@
|
|
|
9997
9989
|
"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"
|
|
9998
9990
|
},
|
|
9999
9991
|
"url": {
|
|
10000
|
-
"format": "uri",
|
|
10001
9992
|
"type": "string",
|
|
10002
9993
|
"fieldDescription": "\n\nThe url to retrieve the content from.\n This must be relative to the add-on's baseUrl.\n\n"
|
|
10003
9994
|
},
|
|
@@ -10195,7 +10186,7 @@
|
|
|
10195
10186
|
"PRODUCT"
|
|
10196
10187
|
],
|
|
10197
10188
|
"type": "string",
|
|
10198
|
-
"fieldDescription": "\n\nThe context for the URL parameter. Not applicable if an absolute URL is specified. Possible values\n <ul>\n <li
|
|
10189
|
+
"fieldDescription": "\n\nThe context for the URL parameter. Not applicable if an absolute URL is specified. Possible values\n <ul>\n <li>`addon` - a URL relative to the add-on's base URL</li>\n <li>`page` - targets a Page module by specifying the Page's module key as the URL</li>\n <li>`product` - a URL relative to the product's base URL</li>\n </ul>\n\n",
|
|
10199
10190
|
"defaultValue": "addon"
|
|
10200
10191
|
},
|
|
10201
10192
|
"name": {
|
|
@@ -10216,33 +10207,6 @@
|
|
|
10216
10207
|
"items": {
|
|
10217
10208
|
"type": "object",
|
|
10218
10209
|
"anyOf": [
|
|
10219
|
-
{
|
|
10220
|
-
"properties": {
|
|
10221
|
-
"condition": {
|
|
10222
|
-
"maxLength": 100,
|
|
10223
|
-
"type": "string",
|
|
10224
|
-
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
10225
|
-
},
|
|
10226
|
-
"invert": {
|
|
10227
|
-
"type": "boolean",
|
|
10228
|
-
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
10229
|
-
"defaultValue": "false"
|
|
10230
|
-
},
|
|
10231
|
-
"params": {
|
|
10232
|
-
"additionalProperties": true,
|
|
10233
|
-
"type": "object",
|
|
10234
|
-
"fieldTitle": "Object",
|
|
10235
|
-
"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"
|
|
10236
|
-
}
|
|
10237
|
-
},
|
|
10238
|
-
"required": [
|
|
10239
|
-
"condition"
|
|
10240
|
-
],
|
|
10241
|
-
"shortClassName": "singleConditionBean",
|
|
10242
|
-
"type": "object",
|
|
10243
|
-
"title": "Single Condition",
|
|
10244
|
-
"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"
|
|
10245
|
-
},
|
|
10246
10210
|
{
|
|
10247
10211
|
"properties": {
|
|
10248
10212
|
"conditions": {
|
|
@@ -10305,6 +10269,33 @@
|
|
|
10305
10269
|
"type": "object",
|
|
10306
10270
|
"title": "Composite Condition",
|
|
10307
10271
|
"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"
|
|
10272
|
+
},
|
|
10273
|
+
{
|
|
10274
|
+
"properties": {
|
|
10275
|
+
"condition": {
|
|
10276
|
+
"maxLength": 100,
|
|
10277
|
+
"type": "string",
|
|
10278
|
+
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
10279
|
+
},
|
|
10280
|
+
"invert": {
|
|
10281
|
+
"type": "boolean",
|
|
10282
|
+
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
10283
|
+
"defaultValue": "false"
|
|
10284
|
+
},
|
|
10285
|
+
"params": {
|
|
10286
|
+
"additionalProperties": true,
|
|
10287
|
+
"type": "object",
|
|
10288
|
+
"fieldTitle": "Object",
|
|
10289
|
+
"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"
|
|
10290
|
+
}
|
|
10291
|
+
},
|
|
10292
|
+
"required": [
|
|
10293
|
+
"condition"
|
|
10294
|
+
],
|
|
10295
|
+
"shortClassName": "singleConditionBean",
|
|
10296
|
+
"type": "object",
|
|
10297
|
+
"title": "Single Condition",
|
|
10298
|
+
"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"
|
|
10308
10299
|
}
|
|
10309
10300
|
]
|
|
10310
10301
|
},
|
|
@@ -10375,7 +10366,6 @@
|
|
|
10375
10366
|
"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"
|
|
10376
10367
|
},
|
|
10377
10368
|
"url": {
|
|
10378
|
-
"format": "uri",
|
|
10379
10369
|
"type": "string",
|
|
10380
10370
|
"fieldDescription": "\n\nThe url to retrieve the content from.\n This must be relative to the add-on's baseUrl.\n\n"
|
|
10381
10371
|
},
|
|
@@ -11392,38 +11382,6 @@
|
|
|
11392
11382
|
"title": "ToggleGroup",
|
|
11393
11383
|
"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"
|
|
11394
11384
|
},
|
|
11395
|
-
{
|
|
11396
|
-
"properties": {
|
|
11397
|
-
"label": {
|
|
11398
|
-
"$ref": "#/definitions/i18nProperty",
|
|
11399
|
-
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
11400
|
-
},
|
|
11401
|
-
"type": {
|
|
11402
|
-
"enum": [
|
|
11403
|
-
"button",
|
|
11404
|
-
"BUTTON"
|
|
11405
|
-
],
|
|
11406
|
-
"type": "string",
|
|
11407
|
-
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
11408
|
-
},
|
|
11409
|
-
"key": {
|
|
11410
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
11411
|
-
"maxLength": 100,
|
|
11412
|
-
"type": "string",
|
|
11413
|
-
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
11414
|
-
}
|
|
11415
|
-
},
|
|
11416
|
-
"required": [
|
|
11417
|
-
"label",
|
|
11418
|
-
"type",
|
|
11419
|
-
"key"
|
|
11420
|
-
],
|
|
11421
|
-
"additionalProperties": true,
|
|
11422
|
-
"shortClassName": "buttonControlBean",
|
|
11423
|
-
"type": "object",
|
|
11424
|
-
"title": "ButtonControl",
|
|
11425
|
-
"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"
|
|
11426
|
-
},
|
|
11427
11385
|
{
|
|
11428
11386
|
"properties": {
|
|
11429
11387
|
"macroParameter": {
|
|
@@ -11511,6 +11469,38 @@
|
|
|
11511
11469
|
"type": "object",
|
|
11512
11470
|
"title": "ControlGroup",
|
|
11513
11471
|
"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"
|
|
11472
|
+
},
|
|
11473
|
+
{
|
|
11474
|
+
"properties": {
|
|
11475
|
+
"label": {
|
|
11476
|
+
"$ref": "#/definitions/i18nProperty",
|
|
11477
|
+
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
11478
|
+
},
|
|
11479
|
+
"type": {
|
|
11480
|
+
"enum": [
|
|
11481
|
+
"button",
|
|
11482
|
+
"BUTTON"
|
|
11483
|
+
],
|
|
11484
|
+
"type": "string",
|
|
11485
|
+
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
11486
|
+
},
|
|
11487
|
+
"key": {
|
|
11488
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
11489
|
+
"maxLength": 100,
|
|
11490
|
+
"type": "string",
|
|
11491
|
+
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
11492
|
+
}
|
|
11493
|
+
},
|
|
11494
|
+
"required": [
|
|
11495
|
+
"label",
|
|
11496
|
+
"type",
|
|
11497
|
+
"key"
|
|
11498
|
+
],
|
|
11499
|
+
"additionalProperties": true,
|
|
11500
|
+
"shortClassName": "buttonControlBean",
|
|
11501
|
+
"type": "object",
|
|
11502
|
+
"title": "ButtonControl",
|
|
11503
|
+
"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"
|
|
11514
11504
|
}
|
|
11515
11505
|
]
|
|
11516
11506
|
},
|
|
@@ -11688,7 +11678,7 @@
|
|
|
11688
11678
|
"PRODUCT"
|
|
11689
11679
|
],
|
|
11690
11680
|
"type": "string",
|
|
11691
|
-
"fieldDescription": "\n\nThe context for the URL parameter. Not applicable if an absolute URL is specified. Possible values\n <ul>\n <li
|
|
11681
|
+
"fieldDescription": "\n\nThe context for the URL parameter. Not applicable if an absolute URL is specified. Possible values\n <ul>\n <li>`addon` - a URL relative to the add-on's base URL</li>\n <li>`page` - targets a Page module by specifying the Page's module key as the URL</li>\n <li>`product` - a URL relative to the product's base URL</li>\n </ul>\n\n",
|
|
11692
11682
|
"defaultValue": "addon"
|
|
11693
11683
|
},
|
|
11694
11684
|
"tooltip": {
|
|
@@ -11713,10 +11703,10 @@
|
|
|
11713
11703
|
"type": "object",
|
|
11714
11704
|
"anyOf": [
|
|
11715
11705
|
{
|
|
11716
|
-
"$ref": "#/definitions/
|
|
11706
|
+
"$ref": "#/definitions/singleCondition"
|
|
11717
11707
|
},
|
|
11718
11708
|
{
|
|
11719
|
-
"$ref": "#/definitions/
|
|
11709
|
+
"$ref": "#/definitions/compositeCondition"
|
|
11720
11710
|
}
|
|
11721
11711
|
]
|
|
11722
11712
|
},
|
|
@@ -11746,6 +11736,67 @@
|
|
|
11746
11736
|
"type": "object",
|
|
11747
11737
|
"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",
|
|
11748
11738
|
"anyOf": [
|
|
11739
|
+
{
|
|
11740
|
+
"properties": {
|
|
11741
|
+
"size": {
|
|
11742
|
+
"enum": [
|
|
11743
|
+
"small",
|
|
11744
|
+
"SMALL",
|
|
11745
|
+
"medium",
|
|
11746
|
+
"MEDIUM",
|
|
11747
|
+
"large",
|
|
11748
|
+
"LARGE",
|
|
11749
|
+
"x-large",
|
|
11750
|
+
"X-LARGE",
|
|
11751
|
+
"fullscreen",
|
|
11752
|
+
"FULLSCREEN",
|
|
11753
|
+
"maximum",
|
|
11754
|
+
"MAXIMUM"
|
|
11755
|
+
],
|
|
11756
|
+
"type": "string",
|
|
11757
|
+
"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"
|
|
11758
|
+
},
|
|
11759
|
+
"chrome": {
|
|
11760
|
+
"type": "boolean",
|
|
11761
|
+
"fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
|
|
11762
|
+
"defaultValue": "true"
|
|
11763
|
+
},
|
|
11764
|
+
"width": {
|
|
11765
|
+
"maxLength": 10,
|
|
11766
|
+
"type": "string",
|
|
11767
|
+
"fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
|
|
11768
|
+
},
|
|
11769
|
+
"header": {
|
|
11770
|
+
"$ref": "#/definitions/i18nProperty",
|
|
11771
|
+
"fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
|
|
11772
|
+
},
|
|
11773
|
+
"height": {
|
|
11774
|
+
"maxLength": 10,
|
|
11775
|
+
"type": "string",
|
|
11776
|
+
"fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
|
|
11777
|
+
}
|
|
11778
|
+
},
|
|
11779
|
+
"shortClassName": "dialogOptions",
|
|
11780
|
+
"type": "object",
|
|
11781
|
+
"title": "Dialog Options",
|
|
11782
|
+
"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"
|
|
11783
|
+
},
|
|
11784
|
+
{
|
|
11785
|
+
"properties": {
|
|
11786
|
+
"key": {
|
|
11787
|
+
"maxLength": 100,
|
|
11788
|
+
"type": "string",
|
|
11789
|
+
"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"
|
|
11790
|
+
}
|
|
11791
|
+
},
|
|
11792
|
+
"required": [
|
|
11793
|
+
"key"
|
|
11794
|
+
],
|
|
11795
|
+
"shortClassName": "dialogModuleOptions",
|
|
11796
|
+
"type": "object",
|
|
11797
|
+
"title": "Dialog Module Options",
|
|
11798
|
+
"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"
|
|
11799
|
+
},
|
|
11749
11800
|
{
|
|
11750
11801
|
"properties": {
|
|
11751
11802
|
"offsetX": {
|
|
@@ -11792,67 +11843,6 @@
|
|
|
11792
11843
|
"type": "object",
|
|
11793
11844
|
"title": "Inline Dialog Options",
|
|
11794
11845
|
"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"
|
|
11795
|
-
},
|
|
11796
|
-
{
|
|
11797
|
-
"properties": {
|
|
11798
|
-
"key": {
|
|
11799
|
-
"maxLength": 100,
|
|
11800
|
-
"type": "string",
|
|
11801
|
-
"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"
|
|
11802
|
-
}
|
|
11803
|
-
},
|
|
11804
|
-
"required": [
|
|
11805
|
-
"key"
|
|
11806
|
-
],
|
|
11807
|
-
"shortClassName": "dialogModuleOptions",
|
|
11808
|
-
"type": "object",
|
|
11809
|
-
"title": "Dialog Module Options",
|
|
11810
|
-
"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"
|
|
11811
|
-
},
|
|
11812
|
-
{
|
|
11813
|
-
"properties": {
|
|
11814
|
-
"size": {
|
|
11815
|
-
"enum": [
|
|
11816
|
-
"small",
|
|
11817
|
-
"SMALL",
|
|
11818
|
-
"medium",
|
|
11819
|
-
"MEDIUM",
|
|
11820
|
-
"large",
|
|
11821
|
-
"LARGE",
|
|
11822
|
-
"x-large",
|
|
11823
|
-
"X-LARGE",
|
|
11824
|
-
"fullscreen",
|
|
11825
|
-
"FULLSCREEN",
|
|
11826
|
-
"maximum",
|
|
11827
|
-
"MAXIMUM"
|
|
11828
|
-
],
|
|
11829
|
-
"type": "string",
|
|
11830
|
-
"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"
|
|
11831
|
-
},
|
|
11832
|
-
"chrome": {
|
|
11833
|
-
"type": "boolean",
|
|
11834
|
-
"fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
|
|
11835
|
-
"defaultValue": "true"
|
|
11836
|
-
},
|
|
11837
|
-
"width": {
|
|
11838
|
-
"maxLength": 10,
|
|
11839
|
-
"type": "string",
|
|
11840
|
-
"fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
|
|
11841
|
-
},
|
|
11842
|
-
"header": {
|
|
11843
|
-
"$ref": "#/definitions/i18nProperty",
|
|
11844
|
-
"fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
|
|
11845
|
-
},
|
|
11846
|
-
"height": {
|
|
11847
|
-
"maxLength": 10,
|
|
11848
|
-
"type": "string",
|
|
11849
|
-
"fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
|
|
11850
|
-
}
|
|
11851
|
-
},
|
|
11852
|
-
"shortClassName": "dialogOptions",
|
|
11853
|
-
"type": "object",
|
|
11854
|
-
"title": "Dialog Options",
|
|
11855
|
-
"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"
|
|
11856
11846
|
}
|
|
11857
11847
|
]
|
|
11858
11848
|
},
|
|
@@ -13589,7 +13579,7 @@
|
|
|
13589
13579
|
},
|
|
13590
13580
|
"listViewComponent": {
|
|
13591
13581
|
"$ref": "#/definitions/componentReference",
|
|
13592
|
-
"fieldDescription": "\n\nDefines a module that will be used when user clicks the navigation link displayed in the space sidebar.<br>\n The module referenced must be a <a href=\"../page/\">generalPage</a>.\n A default list view will be provided if no view component was specified in this field.\n\n"
|
|
13582
|
+
"fieldDescription": "\n\nDefines a module that will be used when a user clicks the navigation link displayed in the space sidebar.<br>\n The module referenced must be a <a href=\"../page/\">generalPage</a>.\n A default list view will be provided if no view component was specified in this field.\n\n"
|
|
13593
13583
|
},
|
|
13594
13584
|
"editComponent": {
|
|
13595
13585
|
"$ref": "#/definitions/componentReference",
|
|
@@ -13621,7 +13611,7 @@
|
|
|
13621
13611
|
},
|
|
13622
13612
|
"contentViewComponent": {
|
|
13623
13613
|
"$ref": "#/definitions/componentReference",
|
|
13624
|
-
"fieldDescription": "\n\nDefines a module for viewing custom content.<br>\n The module referenced must be a <a href=\"../page/\">generalPage</a>.\n\n The view component
|
|
13614
|
+
"fieldDescription": "\n\nDefines a module for viewing custom content.<br>\n The module referenced must be a <a href=\"../page/\">generalPage</a>.\n\n The view component is displayed in these places:\n <ul>\n <li>\n <b>Search result</b><br>\n When a user clicks the title of a custom content entry in site search result.\n </li>\n <li>\n <b>Space List View result</b><br>\n When a user clicks the title of a custom content entry in the space list view.\n </li>\n <li>\n <b>Page List View result</b><br>\n When a user clicks the title of a custom content entry in the page list view.\n </li>\n </ul>\n\n"
|
|
13625
13615
|
},
|
|
13626
13616
|
"editComponentSubmitButtonLabel": {
|
|
13627
13617
|
"$ref": "#/definitions/i18nProperty",
|
|
@@ -13665,7 +13655,7 @@
|
|
|
13665
13655
|
"shortClassName": "customContentUISupportBean",
|
|
13666
13656
|
"type": "object",
|
|
13667
13657
|
"title": "Custom Content UI Support",
|
|
13668
|
-
"description": "\n\nDeclares information related for rendering the custom content in the UI. <br>\n Add-ons have the ability to control the UI components for user to view the custom content.\n\n\n\n\n\n {\n \"contentViewComponent\": {\n \"addonKey\": \"addon-key\",\n \"moduleKey\": \"general-page-module-key\"\n }\n }\n\n\n\n\n <h3>View component example</h3>\n Suppose we already defined a general page module like following:\n\n\n\n\n\n {\n \"url\": \"/my-general-page?content.plugin={content.plugin}&content.id={content.id}&content.version={content.version}&space.key={space.key}&customParameter={ac.customData}\",\n \"name\": {\n \"value\": \"My viewer page\"\n },\n \"key\": \"my-viewer\"\n }\n\n\n\n\n And also the general page is used as a view component in ui support section.\n\n\n\n\n\n {\n \"contentViewComponent\": {\n \"moduleKey\": \"my-viewer\"\n }\n }\n\n\n\n\n When user clicks the title of the corresponding custom content in the search result.\n <code>/my-general-page</code> will be rendered in a iframe with following context parameters being passed.<br>\n <ul>\n <li><code>content.plugin</code>: The content type key of the content. eg: <code>ac:addon-key:module-key</code></li>\n <li><code>content.id</code>: The id of the content</li>\n <li><code>content.version</code>: The version of the content</li>\n <li><code>space.key</code>: The key of the space which content is contained in</li>\n </ul>\n Note, that if an optional custom value is defined in the url string, such as <code>{ac.customData}</code> in the example above, it will be substituted with the value\n of the <code>ac.customData</code> parameter that will be taken from the Confluence's current URL. Add-on developers can specify any number of custom parameters, provided that they\n have names that follow this convention: <code>ac.parameter_name</code>.\n If more than one custom parameter with the same name is defined in Confluence's current URL, only the first value will be used.\n For additional information on custom parameters see <a href=\"../../context-parameters/#add-on-specific-context-parameters\">Context Parameters</a>.\n\n <h3>Context Parameters</h3>\n View components support Confluence context parameters. When rendering the view component\n the context variables will be passed to the URL that is defined in the corresponding view component module.<br>\n You can retrieve the content or space information with these parameters via Confluence REST API\n and render it according to your needs.<br>\n Please consult <a href=\"../../context-parameters/\">Context Parameters</a> for what parameters are currently supported.\n\n"
|
|
13658
|
+
"description": "\n\nDeclares information related for rendering the custom content in the UI. <br>\n Add-ons have the ability to control the UI components for user to view the custom content.\n\n\n\n\n\n {\n \"contentViewComponent\": {\n \"addonKey\": \"addon-key\",\n \"moduleKey\": \"general-page-module-key\"\n }\n }\n\n\n\n\n <h3>View component example</h3>\n Suppose we already defined a general page module like following:\n\n\n\n\n\n {\n \"url\": \"/my-general-page?content.plugin={content.plugin}&content.id={content.id}&content.version={content.version}&space.key={space.key}&customParameter={ac.customData}\",\n \"name\": {\n \"value\": \"My viewer page\"\n },\n \"key\": \"my-viewer\"\n }\n\n\n\n\n And also the general page is used as a view component in ui support section.\n\n\n\n\n\n {\n \"contentViewComponent\": {\n \"moduleKey\": \"my-viewer\"\n }\n }\n\n\n\n\n When a user clicks the title of the corresponding custom content in the search result.\n <code>/my-general-page</code> will be rendered in a iframe with following context parameters being passed.<br>\n <ul>\n <li><code>content.plugin</code>: The content type key of the content. eg: <code>ac:addon-key:module-key</code></li>\n <li><code>content.id</code>: The id of the content</li>\n <li><code>content.version</code>: The version of the content</li>\n <li><code>space.key</code>: The key of the space which content is contained in</li>\n </ul>\n Note, that if an optional custom value is defined in the url string, such as <code>{ac.customData}</code> in the example above, it will be substituted with the value\n of the <code>ac.customData</code> parameter that will be taken from the Confluence's current URL. Add-on developers can specify any number of custom parameters, provided that they\n have names that follow this convention: <code>ac.parameter_name</code>.\n If more than one custom parameter with the same name is defined in Confluence's current URL, only the first value will be used.\n For additional information on custom parameters see <a href=\"../../context-parameters/#add-on-specific-context-parameters\">Context Parameters</a>.\n\n <h3>Context Parameters</h3>\n View components support Confluence context parameters. When rendering the view component\n the context variables will be passed to the URL that is defined in the corresponding view component module.<br>\n You can retrieve the content or space information with these parameters via Confluence REST API\n and render it according to your needs.<br>\n Please consult <a href=\"../../context-parameters/\">Context Parameters</a> for what parameters are currently supported.\n\n"
|
|
13669
13659
|
},
|
|
13670
13660
|
"componentReference": {
|
|
13671
13661
|
"properties": {
|
|
@@ -13707,7 +13697,7 @@
|
|
|
13707
13697
|
"type": "string"
|
|
13708
13698
|
},
|
|
13709
13699
|
"type": "array",
|
|
13710
|
-
"fieldDescription": "\n\nDefines types that can be contained in this custom content.<br>\n Currently supported content types:\n <ul>\n <li><code>attachment</code>: This custom content can contain attachment.</li>\n <li><code>comment</code>: This custom content can contain comment.</li>\n <li>\n Any other content type
|
|
13700
|
+
"fieldDescription": "\n\nDefines types that can be contained in this custom content.<br>\n Currently supported content types:\n <ul>\n <li><code>attachment</code>: This custom content can contain attachment.</li>\n <li><code>comment</code>: This custom content can contain comment.</li>\n <li>\n Any other custom content type defined in the same app.<br>\n Please refer to <a href=\"../custom-content/#content-type-key\">The content type key</a>\n for how to construct the content type key.\n </li>\n </ul>\n\n"
|
|
13711
13701
|
},
|
|
13712
13702
|
"supportedSpacePermissions": {
|
|
13713
13703
|
"items": {
|
|
@@ -13732,7 +13722,7 @@
|
|
|
13732
13722
|
"type": "string"
|
|
13733
13723
|
},
|
|
13734
13724
|
"type": "array",
|
|
13735
|
-
"fieldDescription": "\n\nDefines types that this custom content can be contained in.<br>\n
|
|
13725
|
+
"fieldDescription": "\n\nDefines types that this custom content can be contained in.<br>\n The supported content types are:\n <ul>\n <li><code>space</code>: This custom content can be contained in a space.</li>\n <li><code>page</code>: This custom content can be contained in a page.</li>\n <li><code>blogpost</code>: This custom content can be contained in a blog post.</li>\n <li>\n Any other content type of defined custom content within the same app.<br>\n Any other custom content type defined in the same app.<br>\n Please refer to <a href=\"../custom-content/#content-type-key\">The content type key</a>\n for how to construct the content type key.\n </li>\n </ul>\n\n"
|
|
13736
13726
|
}
|
|
13737
13727
|
},
|
|
13738
13728
|
"required": [
|
|
@@ -13741,7 +13731,7 @@
|
|
|
13741
13731
|
"shortClassName": "customContentAPISupportBean",
|
|
13742
13732
|
"type": "object",
|
|
13743
13733
|
"title": "Custom Content API Support",
|
|
13744
|
-
"description": "\n\nThis property allows you to specify the container types your custom content can appear in, and its supported child content types.\n It also allows you to enable indexing of your custom content.\n\n\n\n\n\n {\n \"bodyType\": \"storage\",\n \"supportedContainerTypes\": [\n \"space\",\n \"page\"\n ],\n \"supportedChildTypes\": [\n \"attachment\",\n \"comment\"\n ],\n \"supportedSpacePermissions\": [],\n \"preventDuplicateTitle\": false,\n \"indexing\": {\n \"enabled\": true\n }\n }\n\n\n\n\n <p>In the above example, you'll see we specify content type keys in the <code>supportedContainerTypes</code> and <code>supportedChildTypes</code> fields.\n There are 2 categories of content type you can reference – built-in content and custom content.</p>\n\n <h3>Built-in content types example</h3>\n The following snippet shows the content type we're defining can:\n <ul>\n <li>Be contained in a <code>space</code> or a <code>page</code></li>\n <li>Have a child <code>comment</code> or a child <code>attachment</code></li>\n </ul>\n\n\n\n\n\n {\n \"bodyType\": \"storage\",\n \"supportedContainerTypes\": [\n \"space\",\n \"page\"\n ],\n \"supportedChildTypes\": [\n \"attachment\",\n \"comment\"\n ],\n \"supportedSpacePermissions\": [],\n \"preventDuplicateTitle\": false,\n \"indexing\": {\n \"enabled\": true\n }\n }\n\n\n\n\n\n <h3>Custom content example</h3>\n The following snippet shows the content type we're defining can:\n <ul>\n <li>Be contained in a content with type <code>type1</code> or <code>type2</code>, defined in
|
|
13734
|
+
"description": "\n\nThis property allows you to specify the container types your custom content can appear in, and its supported child content types.\n It also allows you to enable indexing of your custom content.\n\n\n\n\n\n {\n \"bodyType\": \"storage\",\n \"supportedContainerTypes\": [\n \"space\",\n \"page\"\n ],\n \"supportedChildTypes\": [\n \"attachment\",\n \"comment\"\n ],\n \"supportedSpacePermissions\": [],\n \"preventDuplicateTitle\": false,\n \"indexing\": {\n \"enabled\": true\n }\n }\n\n\n\n\n <p>In the above example, you'll see we specify content type keys in the <code>supportedContainerTypes</code> and <code>supportedChildTypes</code> fields.\n There are 2 categories of content type you can reference – built-in content and custom content.</p>\n\n <h3>Built-in content types example</h3>\n The following snippet shows the content type we're defining can:\n <ul>\n <li>Be contained in a <code>space</code> or a <code>page</code></li>\n <li>Have a child <code>comment</code> or a child <code>attachment</code></li>\n </ul>\n\n\n\n\n\n {\n \"bodyType\": \"storage\",\n \"supportedContainerTypes\": [\n \"space\",\n \"page\"\n ],\n \"supportedChildTypes\": [\n \"attachment\",\n \"comment\"\n ],\n \"supportedSpacePermissions\": [],\n \"preventDuplicateTitle\": false,\n \"indexing\": {\n \"enabled\": true\n }\n }\n\n\n\n\n\n <h3>Custom content example</h3>\n The following snippet shows the content type we're defining can:\n <ul>\n <li>Be contained in a content item with type <code>type1</code> or <code>type2</code>, defined in the app with the key <code>my-first-addon</code></li>\n <li>Have a child of a content item with type <code>type1</code> or <code>type2</code>, defined in the app with the key <code>my-second-addon</code></li>\n </ul>\n\n\n\n\n\n {\n \"bodyType\": \"storage\",\n \"supportedContainerTypes\": [\n \"ac:my-first-addon:type2\",\n \"ac:my-first-addon:type1\"\n ],\n \"supportedChildTypes\": [\n \"ac:my-second-addon:type1\",\n \"ac:my-second-addon:type2\"\n ],\n \"supportedSpacePermissions\": [],\n \"preventDuplicateTitle\": false,\n \"indexing\": {\n \"enabled\": true\n }\n }\n\n\n\n\n <h3>Raw body type custom content example</h3>\n You can define custom content to support a content body with a type of <code>raw</code>.<br>\n This is useful when you want to store, for example, stringified JSON to the content.\n\n\n\n\n\n {\n \"bodyType\": \"raw\",\n \"supportedContainerTypes\": [\n \"space\"\n ],\n \"supportedChildTypes\": [],\n \"supportedSpacePermissions\": [],\n \"preventDuplicateTitle\": false,\n \"indexing\": {\n \"enabled\": true\n }\n }\n\n\n\n\n Content with a raw body looks like this:\n <pre><code>\n {\n \"title\": \"My title\",\n \"space\": {\"key\": \"DS\"},\n \"type\": \"ac:add-on-key:module-key\",\n \"body\": {\n \"raw\": {\n \"value\": \"{\\\"field\\\": \\\"value\\\"}\",\n \"representation\": \"raw\"\n }\n }\n }\n </code></pre>\n\n"
|
|
13745
13735
|
},
|
|
13746
13736
|
"indexing": {
|
|
13747
13737
|
"properties": {
|