@forge/manifest 3.0.0-next.21 → 3.1.0-next.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,69 @@
1
1
  # @forge/manifest
2
2
 
3
+ ## 3.1.0-next.2
4
+
5
+ ### Patch Changes
6
+
7
+ - 14102be: Update manifest definitions
8
+
9
+ ## 3.1.0-next.1
10
+
11
+ ### Patch Changes
12
+
13
+ - 8ee1c58: Update manifest definitions
14
+
15
+ ## 3.1.0-next.0
16
+
17
+ ### Minor Changes
18
+
19
+ - 813f8f3: Add remotes to external auth config
20
+
21
+ ### Patch Changes
22
+
23
+ - 5152239: Update manifest definitions
24
+
25
+ ## 3.0.0
26
+
27
+ ### Major Changes
28
+
29
+ - 4cfa56d: make bearerMethod mandatory in external auth config
30
+
31
+ ### Minor Changes
32
+
33
+ - bd6e025: Add confluence:globalPage module
34
+ - 1c196ff: Add support for external fetch client to reference remote
35
+ - 218fe20: Added an optional connect.authentication property to indicate how the harmonized forge app will be authenticating with tenant API's - using "jwt" or "oauth2". If not specified it defaults to "jwt".
36
+ - 2bca1c0: Show a warning message during forge lint if manifest has deprecated permission scope
37
+ - 0a39c43: Updating forge-manifest to include new Compass Metric scopes
38
+
39
+ ### Patch Changes
40
+
41
+ - 271b98a: add new, granular scopes for custom field related product events
42
+ - 22a488e: Add avi:jira:updated:field:context:configuration product event for scope mapping
43
+ - 689c09b: Update manifest definitions
44
+ - b97660c: Update manifest definitions
45
+ - 7c0d2ee: Update manifest definitions
46
+ - 1dba082: Update manifest definitions
47
+ - d3afe01: Update manifest definitions
48
+ - dfe9dd8: Update manifest definitions
49
+ - 91ea057: Update manifest definitions
50
+ - 3010f0e: Update manifest definitions
51
+ - 2b7c32b: Update manifest definitions
52
+ - e7ee3a7: Update manifest definitions
53
+ - 92d081d: Update manifest definitions
54
+ - d3c8c8d: Update manifest definitions
55
+ - fca240d: Update manifest definitions
56
+ - 36c7c8f: Update manifest definitions
57
+ - d2f6992: Update manifest definitions
58
+ - d18c9f1: Update manifest definitions
59
+ - 1dba082: Update manifest definitions
60
+ - fa963b1: Update manifest definitions
61
+ - 0a7725f: Update manifest definitions
62
+ - 1dba082: Update manifest definitions
63
+ - e4a14c7: Update manifest definitions
64
+ - 2bb89c5: Update manifest definitions
65
+ - 5875eb3: Update manifest definitions
66
+
3
67
  ## 3.0.0-next.21
4
68
 
5
69
  ### Major Changes
@@ -3526,11 +3526,6 @@
3526
3526
  "maxLength": 23,
3527
3527
  "pattern": "^[a-zA-Z0-9_\\-]+$"
3528
3528
  },
3529
- "resourceUploadId": {
3530
- "type": "string",
3531
- "minLength": 1,
3532
- "maxLength": 255
3533
- },
3534
3529
  "key": {
3535
3530
  "$ref": "#/definitions/ModuleKeySchema"
3536
3531
  }
@@ -3618,11 +3613,6 @@
3618
3613
  "maxLength": 23,
3619
3614
  "pattern": "^[a-zA-Z0-9_\\-]+$"
3620
3615
  },
3621
- "resourceUploadId": {
3622
- "type": "string",
3623
- "minLength": 1,
3624
- "maxLength": 255
3625
- },
3626
3616
  "key": {
3627
3617
  "$ref": "#/definitions/ModuleKeySchema"
3628
3618
  }
@@ -3704,11 +3694,6 @@
3704
3694
  "maxLength": 23,
3705
3695
  "pattern": "^[a-zA-Z0-9_\\-]+$"
3706
3696
  },
3707
- "resourceUploadId": {
3708
- "type": "string",
3709
- "minLength": 1,
3710
- "maxLength": 255
3711
- },
3712
3697
  "key": {
3713
3698
  "$ref": "#/definitions/ModuleKeySchema"
3714
3699
  }
@@ -3882,10 +3867,10 @@
3882
3867
  "type": "object",
3883
3868
  "anyOf": [
3884
3869
  {
3885
- "$ref": "#/definitions/compositeCondition"
3870
+ "$ref": "#/definitions/singleCondition"
3886
3871
  },
3887
3872
  {
3888
- "$ref": "#/definitions/singleCondition"
3873
+ "$ref": "#/definitions/compositeCondition"
3889
3874
  }
3890
3875
  ]
3891
3876
  },
@@ -3937,10 +3922,10 @@
3937
3922
  "type": "object",
3938
3923
  "anyOf": [
3939
3924
  {
3940
- "$ref": "#/definitions/singleCondition"
3925
+ "$ref": "#/definitions/compositeCondition"
3941
3926
  },
3942
3927
  {
3943
- "$ref": "#/definitions/compositeCondition"
3928
+ "$ref": "#/definitions/singleCondition"
3944
3929
  }
3945
3930
  ]
3946
3931
  },
@@ -4353,33 +4338,6 @@
4353
4338
  "items": {
4354
4339
  "type": "object",
4355
4340
  "anyOf": [
4356
- {
4357
- "properties": {
4358
- "condition": {
4359
- "maxLength": 100,
4360
- "type": "string",
4361
- "fieldDescription": "\n\nA string indicating the name of the condition\n\n"
4362
- },
4363
- "invert": {
4364
- "type": "boolean",
4365
- "fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
4366
- "defaultValue": "false"
4367
- },
4368
- "params": {
4369
- "additionalProperties": true,
4370
- "type": "object",
4371
- "fieldTitle": "Object",
4372
- "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"
4373
- }
4374
- },
4375
- "required": [
4376
- "condition"
4377
- ],
4378
- "shortClassName": "singleConditionBean",
4379
- "type": "object",
4380
- "title": "Single Condition",
4381
- "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"
4382
- },
4383
4341
  {
4384
4342
  "properties": {
4385
4343
  "conditions": {
@@ -4412,6 +4370,33 @@
4412
4370
  "type": "object",
4413
4371
  "title": "Composite Condition",
4414
4372
  "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"
4373
+ },
4374
+ {
4375
+ "properties": {
4376
+ "condition": {
4377
+ "maxLength": 100,
4378
+ "type": "string",
4379
+ "fieldDescription": "\n\nA string indicating the name of the condition\n\n"
4380
+ },
4381
+ "invert": {
4382
+ "type": "boolean",
4383
+ "fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
4384
+ "defaultValue": "false"
4385
+ },
4386
+ "params": {
4387
+ "additionalProperties": true,
4388
+ "type": "object",
4389
+ "fieldTitle": "Object",
4390
+ "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"
4391
+ }
4392
+ },
4393
+ "required": [
4394
+ "condition"
4395
+ ],
4396
+ "shortClassName": "singleConditionBean",
4397
+ "type": "object",
4398
+ "title": "Single Condition",
4399
+ "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"
4415
4400
  }
4416
4401
  ]
4417
4402
  },
@@ -6515,6 +6500,22 @@
6515
6500
  "type": "object",
6516
6501
  "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",
6517
6502
  "anyOf": [
6503
+ {
6504
+ "properties": {
6505
+ "key": {
6506
+ "maxLength": 100,
6507
+ "type": "string",
6508
+ "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"
6509
+ }
6510
+ },
6511
+ "required": [
6512
+ "key"
6513
+ ],
6514
+ "shortClassName": "dialogModuleOptions",
6515
+ "type": "object",
6516
+ "title": "Dialog Module Options",
6517
+ "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"
6518
+ },
6518
6519
  {
6519
6520
  "properties": {
6520
6521
  "size": {
@@ -6606,22 +6607,6 @@
6606
6607
  "type": "object",
6607
6608
  "title": "Inline Dialog Options",
6608
6609
  "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"
6609
- },
6610
- {
6611
- "properties": {
6612
- "key": {
6613
- "maxLength": 100,
6614
- "type": "string",
6615
- "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"
6616
- }
6617
- },
6618
- "required": [
6619
- "key"
6620
- ],
6621
- "shortClassName": "dialogModuleOptions",
6622
- "type": "object",
6623
- "title": "Dialog Module Options",
6624
- "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"
6625
6610
  }
6626
6611
  ]
6627
6612
  },
@@ -6678,6 +6663,33 @@
6678
6663
  "items": {
6679
6664
  "type": "object",
6680
6665
  "anyOf": [
6666
+ {
6667
+ "properties": {
6668
+ "condition": {
6669
+ "maxLength": 100,
6670
+ "type": "string",
6671
+ "fieldDescription": "\n\nA string indicating the name of the condition\n\n"
6672
+ },
6673
+ "invert": {
6674
+ "type": "boolean",
6675
+ "fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
6676
+ "defaultValue": "false"
6677
+ },
6678
+ "params": {
6679
+ "additionalProperties": true,
6680
+ "type": "object",
6681
+ "fieldTitle": "Object",
6682
+ "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"
6683
+ }
6684
+ },
6685
+ "required": [
6686
+ "condition"
6687
+ ],
6688
+ "shortClassName": "singleConditionBean",
6689
+ "type": "object",
6690
+ "title": "Single Condition",
6691
+ "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"
6692
+ },
6681
6693
  {
6682
6694
  "properties": {
6683
6695
  "conditions": {
@@ -6710,33 +6722,6 @@
6710
6722
  "type": "object",
6711
6723
  "title": "Composite Condition",
6712
6724
  "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"
6713
- },
6714
- {
6715
- "properties": {
6716
- "condition": {
6717
- "maxLength": 100,
6718
- "type": "string",
6719
- "fieldDescription": "\n\nA string indicating the name of the condition\n\n"
6720
- },
6721
- "invert": {
6722
- "type": "boolean",
6723
- "fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
6724
- "defaultValue": "false"
6725
- },
6726
- "params": {
6727
- "additionalProperties": true,
6728
- "type": "object",
6729
- "fieldTitle": "Object",
6730
- "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"
6731
- }
6732
- },
6733
- "required": [
6734
- "condition"
6735
- ],
6736
- "shortClassName": "singleConditionBean",
6737
- "type": "object",
6738
- "title": "Single Condition",
6739
- "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"
6740
6725
  }
6741
6726
  ]
6742
6727
  },
@@ -6941,33 +6926,6 @@
6941
6926
  "items": {
6942
6927
  "type": "object",
6943
6928
  "anyOf": [
6944
- {
6945
- "properties": {
6946
- "condition": {
6947
- "maxLength": 100,
6948
- "type": "string",
6949
- "fieldDescription": "\n\nA string indicating the name of the condition\n\n"
6950
- },
6951
- "invert": {
6952
- "type": "boolean",
6953
- "fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
6954
- "defaultValue": "false"
6955
- },
6956
- "params": {
6957
- "additionalProperties": true,
6958
- "type": "object",
6959
- "fieldTitle": "Object",
6960
- "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"
6961
- }
6962
- },
6963
- "required": [
6964
- "condition"
6965
- ],
6966
- "shortClassName": "singleConditionBean",
6967
- "type": "object",
6968
- "title": "Single Condition",
6969
- "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"
6970
- },
6971
6929
  {
6972
6930
  "properties": {
6973
6931
  "conditions": {
@@ -7000,6 +6958,33 @@
7000
6958
  "type": "object",
7001
6959
  "title": "Composite Condition",
7002
6960
  "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"
6961
+ },
6962
+ {
6963
+ "properties": {
6964
+ "condition": {
6965
+ "maxLength": 100,
6966
+ "type": "string",
6967
+ "fieldDescription": "\n\nA string indicating the name of the condition\n\n"
6968
+ },
6969
+ "invert": {
6970
+ "type": "boolean",
6971
+ "fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
6972
+ "defaultValue": "false"
6973
+ },
6974
+ "params": {
6975
+ "additionalProperties": true,
6976
+ "type": "object",
6977
+ "fieldTitle": "Object",
6978
+ "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"
6979
+ }
6980
+ },
6981
+ "required": [
6982
+ "condition"
6983
+ ],
6984
+ "shortClassName": "singleConditionBean",
6985
+ "type": "object",
6986
+ "title": "Single Condition",
6987
+ "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"
7003
6988
  }
7004
6989
  ]
7005
6990
  },
@@ -7273,38 +7258,6 @@
7273
7258
  "items": {
7274
7259
  "type": "object",
7275
7260
  "anyOf": [
7276
- {
7277
- "properties": {
7278
- "label": {
7279
- "$ref": "#/definitions/i18nProperty",
7280
- "fieldDescription": "\n\nText which will appear inside the button\n\n"
7281
- },
7282
- "type": {
7283
- "enum": [
7284
- "button",
7285
- "BUTTON"
7286
- ],
7287
- "type": "string",
7288
- "fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
7289
- },
7290
- "key": {
7291
- "pattern": "^[a-zA-Z0-9-]+$",
7292
- "maxLength": 100,
7293
- "type": "string",
7294
- "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
7295
- }
7296
- },
7297
- "required": [
7298
- "label",
7299
- "type",
7300
- "key"
7301
- ],
7302
- "additionalProperties": true,
7303
- "shortClassName": "buttonControlBean",
7304
- "type": "object",
7305
- "title": "ButtonControl",
7306
- "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"
7307
- },
7308
7261
  {
7309
7262
  "properties": {
7310
7263
  "controls": {
@@ -7374,6 +7327,38 @@
7374
7327
  "title": "ToggleGroup",
7375
7328
  "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"
7376
7329
  },
7330
+ {
7331
+ "properties": {
7332
+ "label": {
7333
+ "$ref": "#/definitions/i18nProperty",
7334
+ "fieldDescription": "\n\nText which will appear inside the button\n\n"
7335
+ },
7336
+ "type": {
7337
+ "enum": [
7338
+ "button",
7339
+ "BUTTON"
7340
+ ],
7341
+ "type": "string",
7342
+ "fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
7343
+ },
7344
+ "key": {
7345
+ "pattern": "^[a-zA-Z0-9-]+$",
7346
+ "maxLength": 100,
7347
+ "type": "string",
7348
+ "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
7349
+ }
7350
+ },
7351
+ "required": [
7352
+ "label",
7353
+ "type",
7354
+ "key"
7355
+ ],
7356
+ "additionalProperties": true,
7357
+ "shortClassName": "buttonControlBean",
7358
+ "type": "object",
7359
+ "title": "ButtonControl",
7360
+ "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"
7361
+ },
7377
7362
  {
7378
7363
  "properties": {
7379
7364
  "controls": {
@@ -7824,38 +7809,6 @@
7824
7809
  "title": "ToggleGroup",
7825
7810
  "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"
7826
7811
  },
7827
- {
7828
- "properties": {
7829
- "macroParameter": {
7830
- "maxLength": 100,
7831
- "type": "string",
7832
- "fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
7833
- },
7834
- "type": {
7835
- "enum": [
7836
- "text",
7837
- "TEXT"
7838
- ],
7839
- "type": "string",
7840
- "fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
7841
- },
7842
- "key": {
7843
- "pattern": "^[a-zA-Z0-9-]+$",
7844
- "maxLength": 100,
7845
- "type": "string",
7846
- "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"
7847
- }
7848
- },
7849
- "required": [
7850
- "macroParameter",
7851
- "type",
7852
- "key"
7853
- ],
7854
- "shortClassName": "textControlBean",
7855
- "type": "object",
7856
- "title": "TextControl",
7857
- "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"
7858
- },
7859
7812
  {
7860
7813
  "properties": {
7861
7814
  "controls": {
@@ -7912,6 +7865,38 @@
7912
7865
  "title": "ControlGroup",
7913
7866
  "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"
7914
7867
  },
7868
+ {
7869
+ "properties": {
7870
+ "macroParameter": {
7871
+ "maxLength": 100,
7872
+ "type": "string",
7873
+ "fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
7874
+ },
7875
+ "type": {
7876
+ "enum": [
7877
+ "text",
7878
+ "TEXT"
7879
+ ],
7880
+ "type": "string",
7881
+ "fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
7882
+ },
7883
+ "key": {
7884
+ "pattern": "^[a-zA-Z0-9-]+$",
7885
+ "maxLength": 100,
7886
+ "type": "string",
7887
+ "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"
7888
+ }
7889
+ },
7890
+ "required": [
7891
+ "macroParameter",
7892
+ "type",
7893
+ "key"
7894
+ ],
7895
+ "shortClassName": "textControlBean",
7896
+ "type": "object",
7897
+ "title": "TextControl",
7898
+ "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"
7899
+ },
7915
7900
  {
7916
7901
  "properties": {
7917
7902
  "label": {
@@ -8178,22 +8163,6 @@
8178
8163
  "type": "object",
8179
8164
  "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",
8180
8165
  "anyOf": [
8181
- {
8182
- "properties": {
8183
- "key": {
8184
- "maxLength": 100,
8185
- "type": "string",
8186
- "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"
8187
- }
8188
- },
8189
- "required": [
8190
- "key"
8191
- ],
8192
- "shortClassName": "dialogModuleOptions",
8193
- "type": "object",
8194
- "title": "Dialog Module Options",
8195
- "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"
8196
- },
8197
8166
  {
8198
8167
  "properties": {
8199
8168
  "size": {
@@ -8239,6 +8208,22 @@
8239
8208
  "title": "Dialog Options",
8240
8209
  "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"
8241
8210
  },
8211
+ {
8212
+ "properties": {
8213
+ "key": {
8214
+ "maxLength": 100,
8215
+ "type": "string",
8216
+ "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"
8217
+ }
8218
+ },
8219
+ "required": [
8220
+ "key"
8221
+ ],
8222
+ "shortClassName": "dialogModuleOptions",
8223
+ "type": "object",
8224
+ "title": "Dialog Module Options",
8225
+ "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"
8226
+ },
8242
8227
  {
8243
8228
  "properties": {
8244
8229
  "offsetX": {
@@ -8735,8 +8720,8 @@
8735
8720
  "required": [
8736
8721
  "key",
8737
8722
  "name",
8738
- "bearerMethod",
8739
8723
  "integration",
8724
+ "bearerMethod",
8740
8725
  "clientId",
8741
8726
  "remotes"
8742
8727
  ],
@@ -8789,10 +8774,9 @@
8789
8774
  "key",
8790
8775
  "type",
8791
8776
  "name",
8792
- "clientId",
8793
- "actions",
8794
8777
  "bearerMethod",
8795
- "remotes"
8778
+ "clientId",
8779
+ "actions"
8796
8780
  ],
8797
8781
  "properties": {
8798
8782
  "key": {