@forge/manifest 2.5.1-next.3 → 2.6.0-next.7

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
  }
@@ -5356,10 +5417,10 @@
5356
5417
  "type": "object",
5357
5418
  "anyOf": [
5358
5419
  {
5359
- "$ref": "#/definitions/singleCondition"
5420
+ "$ref": "#/definitions/compositeCondition"
5360
5421
  },
5361
5422
  {
5362
- "$ref": "#/definitions/compositeCondition"
5423
+ "$ref": "#/definitions/singleCondition"
5363
5424
  }
5364
5425
  ]
5365
5426
  },
@@ -5427,10 +5488,10 @@
5427
5488
  "type": "object",
5428
5489
  "anyOf": [
5429
5490
  {
5430
- "$ref": "#/definitions/singleCondition"
5491
+ "$ref": "#/definitions/compositeCondition"
5431
5492
  },
5432
5493
  {
5433
- "$ref": "#/definitions/compositeCondition"
5494
+ "$ref": "#/definitions/singleCondition"
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
  },
@@ -5735,53 +5796,6 @@
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": [
5738
- {
5739
- "properties": {
5740
- "offsetX": {
5741
- "maxLength": 10,
5742
- "type": "string",
5743
- "fieldDescription": "\n\nSets an offset distance of the inline-dialog from the trigger element along the x-axis in pixels\n\n"
5744
- },
5745
- "offsetY": {
5746
- "maxLength": 10,
5747
- "type": "string",
5748
- "fieldDescription": "\n\nSets an offset distance of the inline-dialog from the trigger element along the y-axis in pixels\n\n"
5749
- },
5750
- "width": {
5751
- "maxLength": 10,
5752
- "type": "string",
5753
- "fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
5754
- },
5755
- "onTop": {
5756
- "type": "boolean",
5757
- "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"
5758
- },
5759
- "showDelay": {
5760
- "type": "integer",
5761
- "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"
5762
- },
5763
- "closeOthers": {
5764
- "type": "boolean",
5765
- "fieldDescription": "\n\nDetermines if all other dialogs on the screen are closed when this one is opened\n\n"
5766
- },
5767
- "persistent": {
5768
- "type": "boolean",
5769
- "fieldDescription": "\n\nThis option, ignores the 'closeOthers' option\n\n"
5770
- },
5771
- "onHover": {
5772
- "type": "boolean",
5773
- "fieldDescription": "\n\nDetermines whether the inline-Dialog will show on a mouseOver or mouseClick of the trigger\n\n"
5774
- },
5775
- "isRelativeToMouse": {
5776
- "type": "boolean",
5777
- "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"
5778
- }
5779
- },
5780
- "shortClassName": "inlineDialogOptions",
5781
- "type": "object",
5782
- "title": "Inline Dialog Options",
5783
- "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"
5784
- },
5785
5799
  {
5786
5800
  "properties": {
5787
5801
  "size": {
@@ -5842,16 +5856,63 @@
5842
5856
  "type": "object",
5843
5857
  "title": "Dialog Module Options",
5844
5858
  "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"
5845
- }
5846
- ]
5847
- },
5848
- "type": {
5849
- "enum": [
5850
- "page",
5851
- "PAGE",
5852
- "dialog",
5853
- "DIALOG",
5854
- "inlinedialog",
5859
+ },
5860
+ {
5861
+ "properties": {
5862
+ "offsetX": {
5863
+ "maxLength": 10,
5864
+ "type": "string",
5865
+ "fieldDescription": "\n\nSets an offset distance of the inline-dialog from the trigger element along the x-axis in pixels\n\n"
5866
+ },
5867
+ "offsetY": {
5868
+ "maxLength": 10,
5869
+ "type": "string",
5870
+ "fieldDescription": "\n\nSets an offset distance of the inline-dialog from the trigger element along the y-axis in pixels\n\n"
5871
+ },
5872
+ "width": {
5873
+ "maxLength": 10,
5874
+ "type": "string",
5875
+ "fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
5876
+ },
5877
+ "onTop": {
5878
+ "type": "boolean",
5879
+ "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"
5880
+ },
5881
+ "showDelay": {
5882
+ "type": "integer",
5883
+ "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"
5884
+ },
5885
+ "closeOthers": {
5886
+ "type": "boolean",
5887
+ "fieldDescription": "\n\nDetermines if all other dialogs on the screen are closed when this one is opened\n\n"
5888
+ },
5889
+ "persistent": {
5890
+ "type": "boolean",
5891
+ "fieldDescription": "\n\nThis option, ignores the 'closeOthers' option\n\n"
5892
+ },
5893
+ "onHover": {
5894
+ "type": "boolean",
5895
+ "fieldDescription": "\n\nDetermines whether the inline-Dialog will show on a mouseOver or mouseClick of the trigger\n\n"
5896
+ },
5897
+ "isRelativeToMouse": {
5898
+ "type": "boolean",
5899
+ "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"
5900
+ }
5901
+ },
5902
+ "shortClassName": "inlineDialogOptions",
5903
+ "type": "object",
5904
+ "title": "Inline Dialog Options",
5905
+ "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"
5906
+ }
5907
+ ]
5908
+ },
5909
+ "type": {
5910
+ "enum": [
5911
+ "page",
5912
+ "PAGE",
5913
+ "dialog",
5914
+ "DIALOG",
5915
+ "inlinedialog",
5855
5916
  "INLINEDIALOG",
5856
5917
  "dialogmodule",
5857
5918
  "DIALOGMODULE"
@@ -5898,33 +5959,6 @@
5898
5959
  "items": {
5899
5960
  "type": "object",
5900
5961
  "anyOf": [
5901
- {
5902
- "properties": {
5903
- "condition": {
5904
- "maxLength": 100,
5905
- "type": "string",
5906
- "fieldDescription": "\n\nA string indicating the name of the condition\n\n"
5907
- },
5908
- "invert": {
5909
- "type": "boolean",
5910
- "fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
5911
- "defaultValue": "false"
5912
- },
5913
- "params": {
5914
- "additionalProperties": true,
5915
- "type": "object",
5916
- "fieldTitle": "Object",
5917
- "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"
5918
- }
5919
- },
5920
- "required": [
5921
- "condition"
5922
- ],
5923
- "shortClassName": "singleConditionBean",
5924
- "type": "object",
5925
- "title": "Single Condition",
5926
- "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"
5927
- },
5928
5962
  {
5929
5963
  "properties": {
5930
5964
  "conditions": {
@@ -5932,10 +5966,10 @@
5932
5966
  "type": "object",
5933
5967
  "anyOf": [
5934
5968
  {
5935
- "$ref": "#"
5969
+ "$ref": "#/definitions/singleCondition"
5936
5970
  },
5937
5971
  {
5938
- "$ref": "#/definitions/singleCondition"
5972
+ "$ref": "#"
5939
5973
  }
5940
5974
  ]
5941
5975
  },
@@ -5957,6 +5991,33 @@
5957
5991
  "type": "object",
5958
5992
  "title": "Composite Condition",
5959
5993
  "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"
5994
+ },
5995
+ {
5996
+ "properties": {
5997
+ "condition": {
5998
+ "maxLength": 100,
5999
+ "type": "string",
6000
+ "fieldDescription": "\n\nA string indicating the name of the condition\n\n"
6001
+ },
6002
+ "invert": {
6003
+ "type": "boolean",
6004
+ "fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
6005
+ "defaultValue": "false"
6006
+ },
6007
+ "params": {
6008
+ "additionalProperties": true,
6009
+ "type": "object",
6010
+ "fieldTitle": "Object",
6011
+ "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"
6012
+ }
6013
+ },
6014
+ "required": [
6015
+ "condition"
6016
+ ],
6017
+ "shortClassName": "singleConditionBean",
6018
+ "type": "object",
6019
+ "title": "Single Condition",
6020
+ "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"
5960
6021
  }
5961
6022
  ]
5962
6023
  },
@@ -6010,10 +6071,10 @@
6010
6071
  "type": "object",
6011
6072
  "anyOf": [
6012
6073
  {
6013
- "$ref": "#/definitions/singleCondition"
6074
+ "$ref": "#/definitions/compositeCondition"
6014
6075
  },
6015
6076
  {
6016
- "$ref": "#/definitions/compositeCondition"
6077
+ "$ref": "#/definitions/singleCondition"
6017
6078
  }
6018
6079
  ]
6019
6080
  },
@@ -6195,10 +6256,10 @@
6195
6256
  "type": "object",
6196
6257
  "anyOf": [
6197
6258
  {
6198
- "$ref": "#/definitions/singleCondition"
6259
+ "$ref": "#"
6199
6260
  },
6200
6261
  {
6201
- "$ref": "#"
6262
+ "$ref": "#/definitions/singleCondition"
6202
6263
  }
6203
6264
  ]
6204
6265
  },
@@ -6493,38 +6554,6 @@
6493
6554
  "items": {
6494
6555
  "type": "object",
6495
6556
  "anyOf": [
6496
- {
6497
- "properties": {
6498
- "label": {
6499
- "$ref": "#/definitions/i18nProperty",
6500
- "fieldDescription": "\n\nText which will appear inside the button\n\n"
6501
- },
6502
- "type": {
6503
- "enum": [
6504
- "button",
6505
- "BUTTON"
6506
- ],
6507
- "type": "string",
6508
- "fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
6509
- },
6510
- "key": {
6511
- "pattern": "^[a-zA-Z0-9-]+$",
6512
- "maxLength": 100,
6513
- "type": "string",
6514
- "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
6515
- }
6516
- },
6517
- "required": [
6518
- "label",
6519
- "type",
6520
- "key"
6521
- ],
6522
- "additionalProperties": true,
6523
- "shortClassName": "buttonControlBean",
6524
- "type": "object",
6525
- "title": "ButtonControl",
6526
- "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"
6527
- },
6528
6557
  {
6529
6558
  "properties": {
6530
6559
  "controls": {
@@ -6581,6 +6610,38 @@
6581
6610
  "title": "ControlGroup",
6582
6611
  "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"
6583
6612
  },
6613
+ {
6614
+ "properties": {
6615
+ "macroParameter": {
6616
+ "maxLength": 100,
6617
+ "type": "string",
6618
+ "fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
6619
+ },
6620
+ "type": {
6621
+ "enum": [
6622
+ "text",
6623
+ "TEXT"
6624
+ ],
6625
+ "type": "string",
6626
+ "fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
6627
+ },
6628
+ "key": {
6629
+ "pattern": "^[a-zA-Z0-9-]+$",
6630
+ "maxLength": 100,
6631
+ "type": "string",
6632
+ "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"
6633
+ }
6634
+ },
6635
+ "required": [
6636
+ "macroParameter",
6637
+ "type",
6638
+ "key"
6639
+ ],
6640
+ "shortClassName": "textControlBean",
6641
+ "type": "object",
6642
+ "title": "TextControl",
6643
+ "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"
6644
+ },
6584
6645
  {
6585
6646
  "properties": {
6586
6647
  "controls": {
@@ -6652,35 +6713,35 @@
6652
6713
  },
6653
6714
  {
6654
6715
  "properties": {
6655
- "macroParameter": {
6656
- "maxLength": 100,
6657
- "type": "string",
6658
- "fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
6716
+ "label": {
6717
+ "$ref": "#/definitions/i18nProperty",
6718
+ "fieldDescription": "\n\nText which will appear inside the button\n\n"
6659
6719
  },
6660
6720
  "type": {
6661
6721
  "enum": [
6662
- "text",
6663
- "TEXT"
6722
+ "button",
6723
+ "BUTTON"
6664
6724
  ],
6665
6725
  "type": "string",
6666
- "fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
6726
+ "fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
6667
6727
  },
6668
6728
  "key": {
6669
6729
  "pattern": "^[a-zA-Z0-9-]+$",
6670
6730
  "maxLength": 100,
6671
6731
  "type": "string",
6672
- "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"
6732
+ "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
6673
6733
  }
6674
6734
  },
6675
6735
  "required": [
6676
- "macroParameter",
6736
+ "label",
6677
6737
  "type",
6678
6738
  "key"
6679
6739
  ],
6680
- "shortClassName": "textControlBean",
6740
+ "additionalProperties": true,
6741
+ "shortClassName": "buttonControlBean",
6681
6742
  "type": "object",
6682
- "title": "TextControl",
6683
- "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"
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,35 +7094,35 @@
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": {
@@ -7134,35 +7195,35 @@
7134
7195
  },
7135
7196
  {
7136
7197
  "properties": {
7137
- "label": {
7138
- "$ref": "#/definitions/i18nProperty",
7139
- "fieldDescription": "\n\nText which will appear inside the button\n\n"
7198
+ "macroParameter": {
7199
+ "maxLength": 100,
7200
+ "type": "string",
7201
+ "fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
7140
7202
  },
7141
7203
  "type": {
7142
7204
  "enum": [
7143
- "button",
7144
- "BUTTON"
7205
+ "text",
7206
+ "TEXT"
7145
7207
  ],
7146
7208
  "type": "string",
7147
- "fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
7209
+ "fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
7148
7210
  },
7149
7211
  "key": {
7150
7212
  "pattern": "^[a-zA-Z0-9-]+$",
7151
7213
  "maxLength": 100,
7152
7214
  "type": "string",
7153
- "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
7215
+ "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"
7154
7216
  }
7155
7217
  },
7156
7218
  "required": [
7157
- "label",
7219
+ "macroParameter",
7158
7220
  "type",
7159
7221
  "key"
7160
7222
  ],
7161
- "additionalProperties": true,
7162
- "shortClassName": "buttonControlBean",
7223
+ "shortClassName": "textControlBean",
7163
7224
  "type": "object",
7164
- "title": "ButtonControl",
7165
- "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"
7225
+ "title": "TextControl",
7226
+ "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"
7166
7227
  }
7167
7228
  ]
7168
7229
  },
@@ -7365,10 +7426,10 @@
7365
7426
  "type": "object",
7366
7427
  "anyOf": [
7367
7428
  {
7368
- "$ref": "#/definitions/singleCondition"
7429
+ "$ref": "#/definitions/compositeCondition"
7369
7430
  },
7370
7431
  {
7371
- "$ref": "#/definitions/compositeCondition"
7432
+ "$ref": "#/definitions/singleCondition"
7372
7433
  }
7373
7434
  ]
7374
7435
  },
@@ -7398,22 +7459,6 @@
7398
7459
  "type": "object",
7399
7460
  "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",
7400
7461
  "anyOf": [
7401
- {
7402
- "properties": {
7403
- "key": {
7404
- "maxLength": 100,
7405
- "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"
7407
- }
7408
- },
7409
- "required": [
7410
- "key"
7411
- ],
7412
- "shortClassName": "dialogModuleOptions",
7413
- "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"
7416
- },
7417
7462
  {
7418
7463
  "properties": {
7419
7464
  "offsetX": {
@@ -7461,6 +7506,22 @@
7461
7506
  "title": "Inline Dialog Options",
7462
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"
7463
7508
  },
7509
+ {
7510
+ "properties": {
7511
+ "key": {
7512
+ "maxLength": 100,
7513
+ "type": "string",
7514
+ "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"
7515
+ }
7516
+ },
7517
+ "required": [
7518
+ "key"
7519
+ ],
7520
+ "shortClassName": "dialogModuleOptions",
7521
+ "type": "object",
7522
+ "title": "Dialog Module Options",
7523
+ "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"
7524
+ },
7464
7525
  {
7465
7526
  "properties": {
7466
7527
  "size": {
@@ -8794,10 +8855,10 @@
8794
8855
  "type": "object",
8795
8856
  "anyOf": [
8796
8857
  {
8797
- "$ref": "#/definitions/singleCondition"
8858
+ "$ref": "#"
8798
8859
  },
8799
8860
  {
8800
- "$ref": "#"
8861
+ "$ref": "#/definitions/singleCondition"
8801
8862
  }
8802
8863
  ]
8803
8864
  },