@forge/manifest 2.5.1-next.1 → 2.6.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.
@@ -1246,6 +1246,20 @@
1246
1246
  }
1247
1247
  ]
1248
1248
  },
1249
+ "value": {
1250
+ "type": "object",
1251
+ "properties": {
1252
+ "function": {
1253
+ "type": "string",
1254
+ "minLength": 1,
1255
+ "maxLength": 255,
1256
+ "pattern": "^[a-zA-Z0-9-_]+$"
1257
+ }
1258
+ },
1259
+ "required": [
1260
+ "function"
1261
+ ]
1262
+ },
1249
1263
  "key": {
1250
1264
  "$ref": "#/definitions/ModuleKeySchema"
1251
1265
  }
@@ -1362,6 +1376,20 @@
1362
1376
  }
1363
1377
  ]
1364
1378
  },
1379
+ "value": {
1380
+ "type": "object",
1381
+ "properties": {
1382
+ "function": {
1383
+ "type": "string",
1384
+ "minLength": 1,
1385
+ "maxLength": 255,
1386
+ "pattern": "^[a-zA-Z0-9-_]+$"
1387
+ }
1388
+ },
1389
+ "required": [
1390
+ "function"
1391
+ ]
1392
+ },
1365
1393
  "key": {
1366
1394
  "$ref": "#/definitions/ModuleKeySchema"
1367
1395
  }
@@ -1472,6 +1500,20 @@
1472
1500
  }
1473
1501
  ]
1474
1502
  },
1503
+ "value": {
1504
+ "type": "object",
1505
+ "properties": {
1506
+ "function": {
1507
+ "type": "string",
1508
+ "minLength": 1,
1509
+ "maxLength": 255,
1510
+ "pattern": "^[a-zA-Z0-9-_]+$"
1511
+ }
1512
+ },
1513
+ "required": [
1514
+ "function"
1515
+ ]
1516
+ },
1475
1517
  "icon": {
1476
1518
  "type": "string",
1477
1519
  "minLength": 1,
@@ -1639,6 +1681,20 @@
1639
1681
  }
1640
1682
  ]
1641
1683
  },
1684
+ "value": {
1685
+ "type": "object",
1686
+ "properties": {
1687
+ "function": {
1688
+ "type": "string",
1689
+ "minLength": 1,
1690
+ "maxLength": 255,
1691
+ "pattern": "^[a-zA-Z0-9-_]+$"
1692
+ }
1693
+ },
1694
+ "required": [
1695
+ "function"
1696
+ ]
1697
+ },
1642
1698
  "icon": {
1643
1699
  "type": "string",
1644
1700
  "minLength": 1,
@@ -1815,31 +1871,45 @@
1815
1871
  {
1816
1872
  "type": "object",
1817
1873
  "properties": {
1818
- "title": {
1874
+ "function": {
1819
1875
  "type": "string",
1820
1876
  "minLength": 1,
1821
- "maxLength": 255
1877
+ "maxLength": 255,
1878
+ "pattern": "^[a-zA-Z0-9-_]+$"
1879
+ },
1880
+ "title": {
1881
+ "minLength": 1,
1882
+ "maxLength": 255,
1883
+ "type": "string"
1822
1884
  },
1823
1885
  "label": {
1824
- "type": "string",
1825
1886
  "minLength": 1,
1826
- "maxLength": 255
1887
+ "maxLength": 255,
1888
+ "type": "string"
1827
1889
  },
1828
1890
  "status": {
1829
1891
  "type": "object",
1830
1892
  "properties": {
1893
+ "type": {
1894
+ "enum": [
1895
+ "badge",
1896
+ "icon",
1897
+ "lozenge"
1898
+ ],
1899
+ "type": "string"
1900
+ },
1831
1901
  "value": {
1832
1902
  "type": "object",
1833
1903
  "properties": {
1834
1904
  "label": {
1835
- "type": "string",
1836
1905
  "minLength": 1,
1837
- "maxLength": 255
1906
+ "maxLength": 255,
1907
+ "type": "string"
1908
+ },
1909
+ "url": {
1910
+ "type": "string"
1838
1911
  },
1839
1912
  "type": {
1840
- "type": "string",
1841
- "minLength": 1,
1842
- "maxLength": 255,
1843
1913
  "enum": [
1844
1914
  "default",
1845
1915
  "inprogress",
@@ -1847,73 +1917,93 @@
1847
1917
  "new",
1848
1918
  "removed",
1849
1919
  "success"
1850
- ]
1920
+ ],
1921
+ "type": "string"
1851
1922
  }
1852
1923
  },
1853
1924
  "required": [
1854
1925
  "label"
1855
1926
  ]
1856
- },
1857
- "type": {
1858
- "type": "string",
1859
- "minLength": 1,
1860
- "maxLength": 255,
1861
- "enum": [
1862
- "badge",
1863
- "lozenge"
1864
- ]
1865
1927
  }
1866
1928
  },
1867
1929
  "required": [
1868
- "value",
1869
- "type"
1930
+ "type",
1931
+ "value"
1870
1932
  ]
1871
1933
  },
1872
- "function": {
1934
+ "icon": {
1873
1935
  "type": "string",
1874
1936
  "minLength": 1,
1875
- "maxLength": 255,
1876
- "pattern": "^[a-zA-Z0-9-_]+$"
1937
+ "maxLength": 255
1877
1938
  },
1878
1939
  "key": {
1879
1940
  "$ref": "#/definitions/ModuleKeySchema"
1880
1941
  }
1881
1942
  },
1882
1943
  "required": [
1883
- "title",
1884
- "label",
1885
1944
  "function",
1945
+ "label",
1946
+ "title",
1886
1947
  "key"
1887
1948
  ]
1888
1949
  },
1889
1950
  {
1890
1951
  "type": "object",
1891
1952
  "properties": {
1892
- "title": {
1953
+ "resource": {
1893
1954
  "type": "string",
1894
1955
  "minLength": 1,
1895
- "maxLength": 255
1956
+ "maxLength": 23,
1957
+ "pattern": "^[a-zA-Z0-9_\\-]+$"
1958
+ },
1959
+ "resolver": {
1960
+ "additionalProperties": false,
1961
+ "type": "object",
1962
+ "properties": {
1963
+ "function": {
1964
+ "type": "string",
1965
+ "minLength": 1,
1966
+ "maxLength": 255,
1967
+ "pattern": "^[a-zA-Z0-9-_]+$"
1968
+ }
1969
+ },
1970
+ "required": [
1971
+ "function"
1972
+ ]
1973
+ },
1974
+ "title": {
1975
+ "minLength": 1,
1976
+ "maxLength": 255,
1977
+ "type": "string"
1896
1978
  },
1897
1979
  "label": {
1898
- "type": "string",
1899
1980
  "minLength": 1,
1900
- "maxLength": 255
1981
+ "maxLength": 255,
1982
+ "type": "string"
1901
1983
  },
1902
1984
  "status": {
1903
1985
  "type": "object",
1904
1986
  "properties": {
1987
+ "type": {
1988
+ "enum": [
1989
+ "badge",
1990
+ "icon",
1991
+ "lozenge"
1992
+ ],
1993
+ "type": "string"
1994
+ },
1905
1995
  "value": {
1906
1996
  "type": "object",
1907
1997
  "properties": {
1908
1998
  "label": {
1909
- "type": "string",
1910
1999
  "minLength": 1,
1911
- "maxLength": 255
2000
+ "maxLength": 255,
2001
+ "type": "string"
2002
+ },
2003
+ "url": {
2004
+ "type": "string"
1912
2005
  },
1913
2006
  "type": {
1914
- "type": "string",
1915
- "minLength": 1,
1916
- "maxLength": 255,
1917
2007
  "enum": [
1918
2008
  "default",
1919
2009
  "inprogress",
@@ -1921,50 +2011,21 @@
1921
2011
  "new",
1922
2012
  "removed",
1923
2013
  "success"
1924
- ]
2014
+ ],
2015
+ "type": "string"
1925
2016
  }
1926
2017
  },
1927
2018
  "required": [
1928
2019
  "label"
1929
2020
  ]
1930
- },
1931
- "type": {
1932
- "type": "string",
1933
- "minLength": 1,
1934
- "maxLength": 255,
1935
- "enum": [
1936
- "badge",
1937
- "lozenge"
1938
- ]
1939
2021
  }
1940
2022
  },
1941
2023
  "required": [
1942
- "value",
1943
- "type"
1944
- ]
1945
- },
1946
- "resolver": {
1947
- "additionalProperties": false,
1948
- "type": "object",
1949
- "properties": {
1950
- "function": {
1951
- "type": "string",
1952
- "minLength": 1,
1953
- "maxLength": 255,
1954
- "pattern": "^[a-zA-Z0-9-_]+$"
1955
- }
1956
- },
1957
- "required": [
1958
- "function"
2024
+ "type",
2025
+ "value"
1959
2026
  ]
1960
2027
  },
1961
- "resource": {
1962
- "type": "string",
1963
- "minLength": 1,
1964
- "maxLength": 23,
1965
- "pattern": "^[a-zA-Z0-9_\\-]+$"
1966
- },
1967
- "resourceUploadId": {
2028
+ "icon": {
1968
2029
  "type": "string",
1969
2030
  "minLength": 1,
1970
2031
  "maxLength": 255
@@ -1974,9 +2035,9 @@
1974
2035
  }
1975
2036
  },
1976
2037
  "required": [
1977
- "title",
1978
2038
  "label",
1979
2039
  "resource",
2040
+ "title",
1980
2041
  "key"
1981
2042
  ]
1982
2043
  }
@@ -5427,10 +5488,10 @@
5427
5488
  "type": "object",
5428
5489
  "anyOf": [
5429
5490
  {
5430
- "$ref": "#/definitions/compositeCondition"
5491
+ "$ref": "#/definitions/singleCondition"
5431
5492
  },
5432
5493
  {
5433
- "$ref": "#/definitions/singleCondition"
5494
+ "$ref": "#/definitions/compositeCondition"
5434
5495
  }
5435
5496
  ]
5436
5497
  },
@@ -5482,10 +5543,10 @@
5482
5543
  "type": "object",
5483
5544
  "anyOf": [
5484
5545
  {
5485
- "$ref": "#/definitions/compositeCondition"
5546
+ "$ref": "#/definitions/singleCondition"
5486
5547
  },
5487
5548
  {
5488
- "$ref": "#/definitions/singleCondition"
5549
+ "$ref": "#/definitions/compositeCondition"
5489
5550
  }
5490
5551
  ]
5491
5552
  },
@@ -5604,10 +5665,10 @@
5604
5665
  "type": "object",
5605
5666
  "anyOf": [
5606
5667
  {
5607
- "$ref": "#/definitions/singleCondition"
5668
+ "$ref": "#/definitions/compositeCondition"
5608
5669
  },
5609
5670
  {
5610
- "$ref": "#/definitions/compositeCondition"
5671
+ "$ref": "#/definitions/singleCondition"
5611
5672
  }
5612
5673
  ]
5613
5674
  },
@@ -5735,6 +5796,22 @@
5735
5796
  "type": "object",
5736
5797
  "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",
5737
5798
  "anyOf": [
5799
+ {
5800
+ "properties": {
5801
+ "key": {
5802
+ "maxLength": 100,
5803
+ "type": "string",
5804
+ "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"
5805
+ }
5806
+ },
5807
+ "required": [
5808
+ "key"
5809
+ ],
5810
+ "shortClassName": "dialogModuleOptions",
5811
+ "type": "object",
5812
+ "title": "Dialog Module Options",
5813
+ "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"
5814
+ },
5738
5815
  {
5739
5816
  "properties": {
5740
5817
  "size": {
@@ -5780,22 +5857,6 @@
5780
5857
  "title": "Dialog Options",
5781
5858
  "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"
5782
5859
  },
5783
- {
5784
- "properties": {
5785
- "key": {
5786
- "maxLength": 100,
5787
- "type": "string",
5788
- "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"
5789
- }
5790
- },
5791
- "required": [
5792
- "key"
5793
- ],
5794
- "shortClassName": "dialogModuleOptions",
5795
- "type": "object",
5796
- "title": "Dialog Module Options",
5797
- "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"
5798
- },
5799
5860
  {
5800
5861
  "properties": {
5801
5862
  "offsetX": {
@@ -6163,41 +6224,8 @@
6163
6224
  "anyOf": [
6164
6225
  {
6165
6226
  "properties": {
6166
- "conditions": {
6167
- "items": {
6168
- "type": "object",
6169
- "anyOf": [
6170
- {
6171
- "$ref": "#/definitions/singleCondition"
6172
- },
6173
- {
6174
- "$ref": "#"
6175
- }
6176
- ]
6177
- },
6178
- "type": "array",
6179
- "fieldDescription": "\n\nThe conditions to compose using the specific logical operator.\n\n"
6180
- },
6181
- "type": {
6182
- "enum": [
6183
- "and",
6184
- "AND",
6185
- "or",
6186
- "OR"
6187
- ],
6188
- "type": "string",
6189
- "fieldDescription": "\n\nDefines what logical operator is used to evaluate its collection of condition elements.\n\n"
6190
- }
6191
- },
6192
- "shortClassName": "compositeConditionBean",
6193
- "type": "object",
6194
- "title": "Composite Condition",
6195
- "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"
6196
- },
6197
- {
6198
- "properties": {
6199
- "condition": {
6200
- "maxLength": 100,
6227
+ "condition": {
6228
+ "maxLength": 100,
6201
6229
  "type": "string",
6202
6230
  "fieldDescription": "\n\nA string indicating the name of the condition\n\n"
6203
6231
  },
@@ -6220,6 +6248,39 @@
6220
6248
  "type": "object",
6221
6249
  "title": "Single Condition",
6222
6250
  "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"
6251
+ },
6252
+ {
6253
+ "properties": {
6254
+ "conditions": {
6255
+ "items": {
6256
+ "type": "object",
6257
+ "anyOf": [
6258
+ {
6259
+ "$ref": "#/definitions/singleCondition"
6260
+ },
6261
+ {
6262
+ "$ref": "#"
6263
+ }
6264
+ ]
6265
+ },
6266
+ "type": "array",
6267
+ "fieldDescription": "\n\nThe conditions to compose using the specific logical operator.\n\n"
6268
+ },
6269
+ "type": {
6270
+ "enum": [
6271
+ "and",
6272
+ "AND",
6273
+ "or",
6274
+ "OR"
6275
+ ],
6276
+ "type": "string",
6277
+ "fieldDescription": "\n\nDefines what logical operator is used to evaluate its collection of condition elements.\n\n"
6278
+ }
6279
+ },
6280
+ "shortClassName": "compositeConditionBean",
6281
+ "type": "object",
6282
+ "title": "Composite Condition",
6283
+ "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"
6223
6284
  }
6224
6285
  ]
6225
6286
  },
@@ -6493,70 +6554,6 @@
6493
6554
  "items": {
6494
6555
  "type": "object",
6495
6556
  "anyOf": [
6496
- {
6497
- "properties": {
6498
- "macroParameter": {
6499
- "maxLength": 100,
6500
- "type": "string",
6501
- "fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
6502
- },
6503
- "type": {
6504
- "enum": [
6505
- "text",
6506
- "TEXT"
6507
- ],
6508
- "type": "string",
6509
- "fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
6510
- },
6511
- "key": {
6512
- "pattern": "^[a-zA-Z0-9-]+$",
6513
- "maxLength": 100,
6514
- "type": "string",
6515
- "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"
6516
- }
6517
- },
6518
- "required": [
6519
- "macroParameter",
6520
- "type",
6521
- "key"
6522
- ],
6523
- "shortClassName": "textControlBean",
6524
- "type": "object",
6525
- "title": "TextControl",
6526
- "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"
6527
- },
6528
- {
6529
- "properties": {
6530
- "label": {
6531
- "$ref": "#/definitions/i18nProperty",
6532
- "fieldDescription": "\n\nText which will appear inside the button\n\n"
6533
- },
6534
- "type": {
6535
- "enum": [
6536
- "button",
6537
- "BUTTON"
6538
- ],
6539
- "type": "string",
6540
- "fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
6541
- },
6542
- "key": {
6543
- "pattern": "^[a-zA-Z0-9-]+$",
6544
- "maxLength": 100,
6545
- "type": "string",
6546
- "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
6547
- }
6548
- },
6549
- "required": [
6550
- "label",
6551
- "type",
6552
- "key"
6553
- ],
6554
- "additionalProperties": true,
6555
- "shortClassName": "buttonControlBean",
6556
- "type": "object",
6557
- "title": "ButtonControl",
6558
- "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"
6559
- },
6560
6557
  {
6561
6558
  "properties": {
6562
6559
  "controls": {
@@ -6681,6 +6678,70 @@
6681
6678
  "type": "object",
6682
6679
  "title": "ToggleGroup",
6683
6680
  "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"
6681
+ },
6682
+ {
6683
+ "properties": {
6684
+ "macroParameter": {
6685
+ "maxLength": 100,
6686
+ "type": "string",
6687
+ "fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
6688
+ },
6689
+ "type": {
6690
+ "enum": [
6691
+ "text",
6692
+ "TEXT"
6693
+ ],
6694
+ "type": "string",
6695
+ "fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
6696
+ },
6697
+ "key": {
6698
+ "pattern": "^[a-zA-Z0-9-]+$",
6699
+ "maxLength": 100,
6700
+ "type": "string",
6701
+ "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"
6702
+ }
6703
+ },
6704
+ "required": [
6705
+ "macroParameter",
6706
+ "type",
6707
+ "key"
6708
+ ],
6709
+ "shortClassName": "textControlBean",
6710
+ "type": "object",
6711
+ "title": "TextControl",
6712
+ "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"
6713
+ },
6714
+ {
6715
+ "properties": {
6716
+ "label": {
6717
+ "$ref": "#/definitions/i18nProperty",
6718
+ "fieldDescription": "\n\nText which will appear inside the button\n\n"
6719
+ },
6720
+ "type": {
6721
+ "enum": [
6722
+ "button",
6723
+ "BUTTON"
6724
+ ],
6725
+ "type": "string",
6726
+ "fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
6727
+ },
6728
+ "key": {
6729
+ "pattern": "^[a-zA-Z0-9-]+$",
6730
+ "maxLength": 100,
6731
+ "type": "string",
6732
+ "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
6733
+ }
6734
+ },
6735
+ "required": [
6736
+ "label",
6737
+ "type",
6738
+ "key"
6739
+ ],
6740
+ "additionalProperties": true,
6741
+ "shortClassName": "buttonControlBean",
6742
+ "type": "object",
6743
+ "title": "ButtonControl",
6744
+ "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"
6684
6745
  }
6685
6746
  ]
6686
6747
  },
@@ -7033,67 +7094,67 @@
7033
7094
  },
7034
7095
  {
7035
7096
  "properties": {
7036
- "macroParameter": {
7037
- "maxLength": 100,
7038
- "type": "string",
7039
- "fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
7097
+ "label": {
7098
+ "$ref": "#/definitions/i18nProperty",
7099
+ "fieldDescription": "\n\nText which will appear inside the button\n\n"
7040
7100
  },
7041
7101
  "type": {
7042
7102
  "enum": [
7043
- "text",
7044
- "TEXT"
7103
+ "button",
7104
+ "BUTTON"
7045
7105
  ],
7046
7106
  "type": "string",
7047
- "fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
7107
+ "fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
7048
7108
  },
7049
7109
  "key": {
7050
7110
  "pattern": "^[a-zA-Z0-9-]+$",
7051
7111
  "maxLength": 100,
7052
7112
  "type": "string",
7053
- "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"
7113
+ "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
7054
7114
  }
7055
7115
  },
7056
7116
  "required": [
7057
- "macroParameter",
7117
+ "label",
7058
7118
  "type",
7059
7119
  "key"
7060
7120
  ],
7061
- "shortClassName": "textControlBean",
7121
+ "additionalProperties": true,
7122
+ "shortClassName": "buttonControlBean",
7062
7123
  "type": "object",
7063
- "title": "TextControl",
7064
- "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"
7124
+ "title": "ButtonControl",
7125
+ "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"
7065
7126
  },
7066
7127
  {
7067
7128
  "properties": {
7068
- "label": {
7069
- "$ref": "#/definitions/i18nProperty",
7070
- "fieldDescription": "\n\nText which will appear inside the button\n\n"
7129
+ "macroParameter": {
7130
+ "maxLength": 100,
7131
+ "type": "string",
7132
+ "fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
7071
7133
  },
7072
7134
  "type": {
7073
7135
  "enum": [
7074
- "button",
7075
- "BUTTON"
7136
+ "text",
7137
+ "TEXT"
7076
7138
  ],
7077
7139
  "type": "string",
7078
- "fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
7140
+ "fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
7079
7141
  },
7080
7142
  "key": {
7081
7143
  "pattern": "^[a-zA-Z0-9-]+$",
7082
7144
  "maxLength": 100,
7083
7145
  "type": "string",
7084
- "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
7146
+ "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"
7085
7147
  }
7086
7148
  },
7087
7149
  "required": [
7088
- "label",
7150
+ "macroParameter",
7089
7151
  "type",
7090
7152
  "key"
7091
7153
  ],
7092
- "additionalProperties": true,
7093
- "shortClassName": "buttonControlBean",
7154
+ "shortClassName": "textControlBean",
7094
7155
  "type": "object",
7095
- "title": "ButtonControl",
7096
- "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"
7156
+ "title": "TextControl",
7157
+ "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"
7097
7158
  },
7098
7159
  {
7099
7160
  "properties": {
@@ -7400,19 +7461,50 @@
7400
7461
  "anyOf": [
7401
7462
  {
7402
7463
  "properties": {
7403
- "key": {
7404
- "maxLength": 100,
7464
+ "offsetX": {
7465
+ "maxLength": 10,
7405
7466
  "type": "string",
7406
- "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"
7467
+ "fieldDescription": "\n\nSets an offset distance of the inline-dialog from the trigger element along the x-axis in pixels\n\n"
7468
+ },
7469
+ "offsetY": {
7470
+ "maxLength": 10,
7471
+ "type": "string",
7472
+ "fieldDescription": "\n\nSets an offset distance of the inline-dialog from the trigger element along the y-axis in pixels\n\n"
7473
+ },
7474
+ "width": {
7475
+ "maxLength": 10,
7476
+ "type": "string",
7477
+ "fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
7478
+ },
7479
+ "onTop": {
7480
+ "type": "boolean",
7481
+ "fieldDescription": "\n\nDetermines if the dialog should be shown above the trigger or not. If this option is true but there is insufficient room above the trigger the inline-dialog will be flipped to display below it\n\n"
7482
+ },
7483
+ "showDelay": {
7484
+ "type": "integer",
7485
+ "fieldDescription": "\n\nDetermines how long in milliseconds after a show trigger is fired (such as a trigger click) until the dialog is shown\n\n"
7486
+ },
7487
+ "closeOthers": {
7488
+ "type": "boolean",
7489
+ "fieldDescription": "\n\nDetermines if all other dialogs on the screen are closed when this one is opened\n\n"
7490
+ },
7491
+ "persistent": {
7492
+ "type": "boolean",
7493
+ "fieldDescription": "\n\nThis option, ignores the 'closeOthers' option\n\n"
7494
+ },
7495
+ "onHover": {
7496
+ "type": "boolean",
7497
+ "fieldDescription": "\n\nDetermines whether the inline-Dialog will show on a mouseOver or mouseClick of the trigger\n\n"
7498
+ },
7499
+ "isRelativeToMouse": {
7500
+ "type": "boolean",
7501
+ "fieldDescription": "\n\nDetermines if the dialog should be shown relative to where the mouse is at the time of the event trigger (normally a click) if set to false the dialog will show aligned to the left of the trigger with the arrow showing at the center\n\n"
7407
7502
  }
7408
7503
  },
7409
- "required": [
7410
- "key"
7411
- ],
7412
- "shortClassName": "dialogModuleOptions",
7504
+ "shortClassName": "inlineDialogOptions",
7413
7505
  "type": "object",
7414
- "title": "Dialog Module Options",
7415
- "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"
7506
+ "title": "Inline Dialog Options",
7507
+ "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"
7416
7508
  },
7417
7509
  {
7418
7510
  "properties": {
@@ -7461,50 +7553,19 @@
7461
7553
  },
7462
7554
  {
7463
7555
  "properties": {
7464
- "offsetX": {
7465
- "maxLength": 10,
7466
- "type": "string",
7467
- "fieldDescription": "\n\nSets an offset distance of the inline-dialog from the trigger element along the x-axis in pixels\n\n"
7468
- },
7469
- "offsetY": {
7470
- "maxLength": 10,
7471
- "type": "string",
7472
- "fieldDescription": "\n\nSets an offset distance of the inline-dialog from the trigger element along the y-axis in pixels\n\n"
7473
- },
7474
- "width": {
7475
- "maxLength": 10,
7556
+ "key": {
7557
+ "maxLength": 100,
7476
7558
  "type": "string",
7477
- "fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
7478
- },
7479
- "onTop": {
7480
- "type": "boolean",
7481
- "fieldDescription": "\n\nDetermines if the dialog should be shown above the trigger or not. If this option is true but there is insufficient room above the trigger the inline-dialog will be flipped to display below it\n\n"
7482
- },
7483
- "showDelay": {
7484
- "type": "integer",
7485
- "fieldDescription": "\n\nDetermines how long in milliseconds after a show trigger is fired (such as a trigger click) until the dialog is shown\n\n"
7486
- },
7487
- "closeOthers": {
7488
- "type": "boolean",
7489
- "fieldDescription": "\n\nDetermines if all other dialogs on the screen are closed when this one is opened\n\n"
7490
- },
7491
- "persistent": {
7492
- "type": "boolean",
7493
- "fieldDescription": "\n\nThis option, ignores the 'closeOthers' option\n\n"
7494
- },
7495
- "onHover": {
7496
- "type": "boolean",
7497
- "fieldDescription": "\n\nDetermines whether the inline-Dialog will show on a mouseOver or mouseClick of the trigger\n\n"
7498
- },
7499
- "isRelativeToMouse": {
7500
- "type": "boolean",
7501
- "fieldDescription": "\n\nDetermines if the dialog should be shown relative to where the mouse is at the time of the event trigger (normally a click) if set to false the dialog will show aligned to the left of the trigger with the arrow showing at the center\n\n"
7559
+ "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"
7502
7560
  }
7503
7561
  },
7504
- "shortClassName": "inlineDialogOptions",
7562
+ "required": [
7563
+ "key"
7564
+ ],
7565
+ "shortClassName": "dialogModuleOptions",
7505
7566
  "type": "object",
7506
- "title": "Inline Dialog Options",
7507
- "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"
7567
+ "title": "Dialog Module Options",
7568
+ "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"
7508
7569
  }
7509
7570
  ]
7510
7571
  },
@@ -7618,6 +7679,10 @@
7618
7679
  "type": "string",
7619
7680
  "fieldDescription": "\n\nFires when an add on has been successfully disabled. This is an asynchronous notification event.\n\n"
7620
7681
  },
7682
+ "dare-migration": {
7683
+ "type": "string",
7684
+ "fieldDescription": "\n\nUsed DaRe app migration service to trigger migrations events\n\n"
7685
+ },
7621
7686
  "uninstalled": {
7622
7687
  "format": "uri",
7623
7688
  "type": "string",