@forge/manifest 2.3.1-next.2 → 2.4.0-next.6

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.
@@ -2830,10 +2830,10 @@
2830
2830
  "type": "object",
2831
2831
  "anyOf": [
2832
2832
  {
2833
- "$ref": "#/definitions/compositeCondition"
2833
+ "$ref": "#/definitions/singleCondition"
2834
2834
  },
2835
2835
  {
2836
- "$ref": "#/definitions/singleCondition"
2836
+ "$ref": "#/definitions/compositeCondition"
2837
2837
  }
2838
2838
  ]
2839
2839
  },
@@ -2885,10 +2885,10 @@
2885
2885
  "type": "object",
2886
2886
  "anyOf": [
2887
2887
  {
2888
- "$ref": "#/definitions/singleCondition"
2888
+ "$ref": "#/definitions/compositeCondition"
2889
2889
  },
2890
2890
  {
2891
- "$ref": "#/definitions/compositeCondition"
2891
+ "$ref": "#/definitions/singleCondition"
2892
2892
  }
2893
2893
  ]
2894
2894
  },
@@ -2949,10 +2949,10 @@
2949
2949
  "type": "object",
2950
2950
  "anyOf": [
2951
2951
  {
2952
- "$ref": "#/definitions/singleCondition"
2952
+ "$ref": "#/definitions/compositeCondition"
2953
2953
  },
2954
2954
  {
2955
- "$ref": "#/definitions/compositeCondition"
2955
+ "$ref": "#/definitions/singleCondition"
2956
2956
  }
2957
2957
  ]
2958
2958
  },
@@ -3065,10 +3065,10 @@
3065
3065
  "type": "object",
3066
3066
  "anyOf": [
3067
3067
  {
3068
- "$ref": "#/definitions/singleCondition"
3068
+ "$ref": "#/definitions/compositeCondition"
3069
3069
  },
3070
3070
  {
3071
- "$ref": "#/definitions/compositeCondition"
3071
+ "$ref": "#/definitions/singleCondition"
3072
3072
  }
3073
3073
  ]
3074
3074
  },
@@ -3308,10 +3308,10 @@
3308
3308
  "type": "object",
3309
3309
  "anyOf": [
3310
3310
  {
3311
- "$ref": "#"
3311
+ "$ref": "#/definitions/singleCondition"
3312
3312
  },
3313
3313
  {
3314
- "$ref": "#/definitions/singleCondition"
3314
+ "$ref": "#"
3315
3315
  }
3316
3316
  ]
3317
3317
  },
@@ -3634,10 +3634,10 @@
3634
3634
  "type": "object",
3635
3635
  "anyOf": [
3636
3636
  {
3637
- "$ref": "#/definitions/singleCondition"
3637
+ "$ref": "#/definitions/compositeCondition"
3638
3638
  },
3639
3639
  {
3640
- "$ref": "#/definitions/compositeCondition"
3640
+ "$ref": "#/definitions/singleCondition"
3641
3641
  }
3642
3642
  ]
3643
3643
  },
@@ -3777,10 +3777,10 @@
3777
3777
  "type": "object",
3778
3778
  "anyOf": [
3779
3779
  {
3780
- "$ref": "#/definitions/singleCondition"
3780
+ "$ref": "#/definitions/compositeCondition"
3781
3781
  },
3782
3782
  {
3783
- "$ref": "#/definitions/compositeCondition"
3783
+ "$ref": "#/definitions/singleCondition"
3784
3784
  }
3785
3785
  ]
3786
3786
  },
@@ -3823,10 +3823,10 @@
3823
3823
  "type": "object",
3824
3824
  "anyOf": [
3825
3825
  {
3826
- "$ref": "#/definitions/singleCondition"
3826
+ "$ref": "#/definitions/compositeCondition"
3827
3827
  },
3828
3828
  {
3829
- "$ref": "#/definitions/compositeCondition"
3829
+ "$ref": "#/definitions/singleCondition"
3830
3830
  }
3831
3831
  ]
3832
3832
  },
@@ -3960,10 +3960,10 @@
3960
3960
  "type": "object",
3961
3961
  "anyOf": [
3962
3962
  {
3963
- "$ref": "#/definitions/singleCondition"
3963
+ "$ref": "#/definitions/compositeCondition"
3964
3964
  },
3965
3965
  {
3966
- "$ref": "#/definitions/compositeCondition"
3966
+ "$ref": "#/definitions/singleCondition"
3967
3967
  }
3968
3968
  ]
3969
3969
  },
@@ -4062,10 +4062,10 @@
4062
4062
  "type": "object",
4063
4063
  "anyOf": [
4064
4064
  {
4065
- "$ref": "#/definitions/compositeCondition"
4065
+ "$ref": "#/definitions/singleCondition"
4066
4066
  },
4067
4067
  {
4068
- "$ref": "#/definitions/singleCondition"
4068
+ "$ref": "#/definitions/compositeCondition"
4069
4069
  }
4070
4070
  ]
4071
4071
  },
@@ -4193,39 +4193,15 @@
4193
4193
  "items": {
4194
4194
  "type": "object",
4195
4195
  "anyOf": [
4196
- {
4197
- "properties": {
4198
- "condition": {
4199
- "maxLength": 100,
4200
- "type": "string",
4201
- "fieldDescription": "\n\nA string indicating the name of the condition\n\n"
4202
- },
4203
- "invert": {
4204
- "type": "boolean",
4205
- "fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
4206
- "defaultValue": "false"
4207
- },
4208
- "params": {
4209
- "additionalProperties": true,
4210
- "type": "object",
4211
- "fieldTitle": "Object",
4212
- "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"
4213
- }
4214
- },
4215
- "required": [
4216
- "condition"
4217
- ],
4218
- "shortClassName": "singleConditionBean",
4219
- "type": "object",
4220
- "title": "Single Condition",
4221
- "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"
4222
- },
4223
4196
  {
4224
4197
  "properties": {
4225
4198
  "conditions": {
4226
4199
  "items": {
4227
4200
  "type": "object",
4228
4201
  "anyOf": [
4202
+ {
4203
+ "$ref": "#/definitions/singleCondition"
4204
+ },
4229
4205
  {
4230
4206
  "properties": {
4231
4207
  "conditions": {
@@ -4258,9 +4234,6 @@
4258
4234
  "type": "object",
4259
4235
  "title": "Composite Condition",
4260
4236
  "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"
4261
- },
4262
- {
4263
- "$ref": "#/definitions/singleCondition"
4264
4237
  }
4265
4238
  ]
4266
4239
  },
@@ -4282,6 +4255,33 @@
4282
4255
  "type": "object",
4283
4256
  "title": "Composite Condition",
4284
4257
  "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"
4258
+ },
4259
+ {
4260
+ "properties": {
4261
+ "condition": {
4262
+ "maxLength": 100,
4263
+ "type": "string",
4264
+ "fieldDescription": "\n\nA string indicating the name of the condition\n\n"
4265
+ },
4266
+ "invert": {
4267
+ "type": "boolean",
4268
+ "fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
4269
+ "defaultValue": "false"
4270
+ },
4271
+ "params": {
4272
+ "additionalProperties": true,
4273
+ "type": "object",
4274
+ "fieldTitle": "Object",
4275
+ "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"
4276
+ }
4277
+ },
4278
+ "required": [
4279
+ "condition"
4280
+ ],
4281
+ "shortClassName": "singleConditionBean",
4282
+ "type": "object",
4283
+ "title": "Single Condition",
4284
+ "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"
4285
4285
  }
4286
4286
  ]
4287
4287
  },
@@ -4508,39 +4508,15 @@
4508
4508
  "items": {
4509
4509
  "type": "object",
4510
4510
  "anyOf": [
4511
- {
4512
- "properties": {
4513
- "condition": {
4514
- "maxLength": 100,
4515
- "type": "string",
4516
- "fieldDescription": "\n\nA string indicating the name of the condition\n\n"
4517
- },
4518
- "invert": {
4519
- "type": "boolean",
4520
- "fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
4521
- "defaultValue": "false"
4522
- },
4523
- "params": {
4524
- "additionalProperties": true,
4525
- "type": "object",
4526
- "fieldTitle": "Object",
4527
- "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"
4528
- }
4529
- },
4530
- "required": [
4531
- "condition"
4532
- ],
4533
- "shortClassName": "singleConditionBean",
4534
- "type": "object",
4535
- "title": "Single Condition",
4536
- "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"
4537
- },
4538
4511
  {
4539
4512
  "properties": {
4540
4513
  "conditions": {
4541
4514
  "items": {
4542
4515
  "type": "object",
4543
4516
  "anyOf": [
4517
+ {
4518
+ "$ref": "#/definitions/singleCondition"
4519
+ },
4544
4520
  {
4545
4521
  "properties": {
4546
4522
  "conditions": {
@@ -4573,9 +4549,6 @@
4573
4549
  "type": "object",
4574
4550
  "title": "Composite Condition",
4575
4551
  "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"
4576
- },
4577
- {
4578
- "$ref": "#/definitions/singleCondition"
4579
4552
  }
4580
4553
  ]
4581
4554
  },
@@ -4597,6 +4570,33 @@
4597
4570
  "type": "object",
4598
4571
  "title": "Composite Condition",
4599
4572
  "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"
4573
+ },
4574
+ {
4575
+ "properties": {
4576
+ "condition": {
4577
+ "maxLength": 100,
4578
+ "type": "string",
4579
+ "fieldDescription": "\n\nA string indicating the name of the condition\n\n"
4580
+ },
4581
+ "invert": {
4582
+ "type": "boolean",
4583
+ "fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
4584
+ "defaultValue": "false"
4585
+ },
4586
+ "params": {
4587
+ "additionalProperties": true,
4588
+ "type": "object",
4589
+ "fieldTitle": "Object",
4590
+ "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"
4591
+ }
4592
+ },
4593
+ "required": [
4594
+ "condition"
4595
+ ],
4596
+ "shortClassName": "singleConditionBean",
4597
+ "type": "object",
4598
+ "title": "Single Condition",
4599
+ "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"
4600
4600
  }
4601
4601
  ]
4602
4602
  },
@@ -4762,10 +4762,10 @@
4762
4762
  "type": "object",
4763
4763
  "anyOf": [
4764
4764
  {
4765
- "$ref": "#/definitions/compositeCondition"
4765
+ "$ref": "#/definitions/singleCondition"
4766
4766
  },
4767
4767
  {
4768
- "$ref": "#/definitions/singleCondition"
4768
+ "$ref": "#/definitions/compositeCondition"
4769
4769
  }
4770
4770
  ]
4771
4771
  },
@@ -4803,7 +4803,7 @@
4803
4803
  },
4804
4804
  "expression": {
4805
4805
  "type": "string",
4806
- "fieldDescription": "\n\nThe [Jira expression](https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-api-3-expression-eval-post)\n used to evaluate the validator. Must return a boolean value.\n <p>\n This expression can be overridden using the configuration page.\n If you return configuration with property \"expression\", then that expression will be used\n to evaluate the validator instead of the expression defined here. For example:\n\n <pre><code>AP.require([\"jira\"], function(jira) {\n jira.WorkflowConfiguration.onSave(function() {\n var config = {\n \"expression\": \"dynamically built expression\"\n };\n return JSON.stringify(config);\n });\n});</code></pre>\n\n"
4806
+ "fieldDescription": "\n\nThe [Jira expression](https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-api-3-expression-eval-post)\n used to evaluate the validator. Must return a boolean or string value.\n <p>\n This expression can be overridden using the configuration page.\n If you return configuration with property \"expression\", then that expression will be used\n to evaluate the validator instead of the expression defined here. For example:\n\n <pre><code>AP.require([\"jira\"], function(jira) {\n jira.WorkflowConfiguration.onSave(function() {\n var config = {\n \"expression\": \"dynamically built expression\"\n };\n return JSON.stringify(config);\n });\n});</code></pre>\n\n"
4807
4807
  },
4808
4808
  "edit": {
4809
4809
  "$ref": "#/definitions/url",
@@ -4821,14 +4821,29 @@
4821
4821
  },
4822
4822
  "errorMessage": {
4823
4823
  "type": "object",
4824
- "fieldDescription": "\n\nThe error message that will be shown if the validator rejects the transition.\n <p>\n This can be either a static [i18n property](../i18n-property/), or an object containing the \"expression\" property,\n with a Jira expression that returns the error message dynamically, based on the current transition or configuration.\n\n",
4824
+ "fieldDescription": "\n\nThe error message that will be shown if the validator rejects the transition by returning <code>false</code>.\n <p>\n This can be either a static [i18n property](../i18n-property/), or an object containing the \"expression\" property,\n with a Jira expression that returns the error message dynamically, based on the current transition or configuration.\n\n",
4825
4825
  "anyOf": [
4826
+ {
4827
+ "properties": {
4828
+ "expression": {
4829
+ "type": "string",
4830
+ "fieldDescription": "\n\nThe Jira expression that will return an error message if the validator rejects a transition.\n\n"
4831
+ }
4832
+ },
4833
+ "required": [
4834
+ "expression"
4835
+ ],
4836
+ "shortClassName": "validatorJiraExpressionErrorMessage",
4837
+ "type": "object",
4838
+ "title": "Jira Expression Error Message",
4839
+ "description": "\n\nA Jira expression that will be evaluated if the workflow validator fails.\n The string returned by the Jira expression will be displayed as the error message for the failed transition.\n\n"
4840
+ },
4826
4841
  {
4827
4842
  "properties": {
4828
4843
  "value": {
4829
4844
  "maxLength": 1500,
4830
4845
  "type": "string",
4831
- "fieldDescription": "\n\nThe human-readable default value. This will be used if no translation exists.\n\n"
4846
+ "fieldDescription": "\n\nThe human-readable default value. This will be used if no translation exists.\n Only the following HTML tags are supported: `b`, `i`, `strong`, `em`, and `code`.\n\n"
4832
4847
  },
4833
4848
  "i18n": {
4834
4849
  "maxLength": 300,
@@ -4843,21 +4858,6 @@
4843
4858
  "type": "object",
4844
4859
  "title": "i18n Property",
4845
4860
  "description": "\n\nRepresents a string that can be resolved via a localization properties file. You can use the same `i18n Property` key\n and value in multiple places if you like, but identical keys must have identical values.\n\n <h3>Example</h3>\n\n\n\n\n\n {\n \"value\": \"My text\"\n }\n\n\n"
4846
- },
4847
- {
4848
- "properties": {
4849
- "expression": {
4850
- "type": "string",
4851
- "fieldDescription": "\n\nThe Jira expression that will return an error message if the validator rejects a transition.\n\n"
4852
- }
4853
- },
4854
- "required": [
4855
- "expression"
4856
- ],
4857
- "shortClassName": "validatorJiraExpressionErrorMessage",
4858
- "type": "object",
4859
- "title": "Jira Expression Error Message",
4860
- "description": "\n\nA Jira expression that will be evaluated if the workflow validator fails.\n The string returned by the Jira expression will be displayed as the error message for the failed transition.\n\n"
4861
4861
  }
4862
4862
  ]
4863
4863
  },
@@ -5080,10 +5080,10 @@
5080
5080
  "type": "object",
5081
5081
  "anyOf": [
5082
5082
  {
5083
- "$ref": "#/definitions/singleCondition"
5083
+ "$ref": "#/definitions/compositeCondition"
5084
5084
  },
5085
5085
  {
5086
- "$ref": "#/definitions/compositeCondition"
5086
+ "$ref": "#/definitions/singleCondition"
5087
5087
  }
5088
5088
  ]
5089
5089
  },
@@ -5270,10 +5270,10 @@
5270
5270
  "type": "object",
5271
5271
  "anyOf": [
5272
5272
  {
5273
- "$ref": "#/definitions/singleCondition"
5273
+ "$ref": "#/definitions/compositeCondition"
5274
5274
  },
5275
5275
  {
5276
- "$ref": "#/definitions/compositeCondition"
5276
+ "$ref": "#/definitions/singleCondition"
5277
5277
  }
5278
5278
  ]
5279
5279
  },
@@ -5386,10 +5386,10 @@
5386
5386
  "type": "object",
5387
5387
  "anyOf": [
5388
5388
  {
5389
- "$ref": "#/definitions/singleCondition"
5389
+ "$ref": "#/definitions/compositeCondition"
5390
5390
  },
5391
5391
  {
5392
- "$ref": "#/definitions/compositeCondition"
5392
+ "$ref": "#/definitions/singleCondition"
5393
5393
  }
5394
5394
  ]
5395
5395
  },
@@ -5504,22 +5504,6 @@
5504
5504
  "title": "Dialog Options",
5505
5505
  "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"
5506
5506
  },
5507
- {
5508
- "properties": {
5509
- "key": {
5510
- "maxLength": 100,
5511
- "type": "string",
5512
- "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"
5513
- }
5514
- },
5515
- "required": [
5516
- "key"
5517
- ],
5518
- "shortClassName": "dialogModuleOptions",
5519
- "type": "object",
5520
- "title": "Dialog Module Options",
5521
- "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"
5522
- },
5523
5507
  {
5524
5508
  "properties": {
5525
5509
  "offsetX": {
@@ -5566,6 +5550,22 @@
5566
5550
  "type": "object",
5567
5551
  "title": "Inline Dialog Options",
5568
5552
  "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"
5553
+ },
5554
+ {
5555
+ "properties": {
5556
+ "key": {
5557
+ "maxLength": 100,
5558
+ "type": "string",
5559
+ "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"
5560
+ }
5561
+ },
5562
+ "required": [
5563
+ "key"
5564
+ ],
5565
+ "shortClassName": "dialogModuleOptions",
5566
+ "type": "object",
5567
+ "title": "Dialog Module Options",
5568
+ "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"
5569
5569
  }
5570
5570
  ]
5571
5571
  },
@@ -5734,10 +5734,10 @@
5734
5734
  "type": "object",
5735
5735
  "anyOf": [
5736
5736
  {
5737
- "$ref": "#/definitions/singleCondition"
5737
+ "$ref": "#/definitions/compositeCondition"
5738
5738
  },
5739
5739
  {
5740
- "$ref": "#/definitions/compositeCondition"
5740
+ "$ref": "#/definitions/singleCondition"
5741
5741
  }
5742
5742
  ]
5743
5743
  },
@@ -5919,10 +5919,10 @@
5919
5919
  "type": "object",
5920
5920
  "anyOf": [
5921
5921
  {
5922
- "$ref": "#"
5922
+ "$ref": "#/definitions/singleCondition"
5923
5923
  },
5924
5924
  {
5925
- "$ref": "#/definitions/singleCondition"
5925
+ "$ref": "#"
5926
5926
  }
5927
5927
  ]
5928
5928
  },
@@ -6219,16 +6219,48 @@
6219
6219
  "anyOf": [
6220
6220
  {
6221
6221
  "properties": {
6222
- "controls": {
6223
- "items": {
6224
- "properties": {
6225
- "macroParameterValue": {
6226
- "maxLength": 10000,
6227
- "type": "string",
6228
- "fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n"
6229
- },
6230
- "label": {
6231
- "$ref": "#/definitions/i18nProperty",
6222
+ "label": {
6223
+ "$ref": "#/definitions/i18nProperty",
6224
+ "fieldDescription": "\n\nText which will appear inside the button\n\n"
6225
+ },
6226
+ "type": {
6227
+ "enum": [
6228
+ "button",
6229
+ "BUTTON"
6230
+ ],
6231
+ "type": "string",
6232
+ "fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
6233
+ },
6234
+ "key": {
6235
+ "pattern": "^[a-zA-Z0-9-]+$",
6236
+ "maxLength": 100,
6237
+ "type": "string",
6238
+ "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
6239
+ }
6240
+ },
6241
+ "required": [
6242
+ "label",
6243
+ "type",
6244
+ "key"
6245
+ ],
6246
+ "additionalProperties": true,
6247
+ "shortClassName": "buttonControlBean",
6248
+ "type": "object",
6249
+ "title": "ButtonControl",
6250
+ "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"
6251
+ },
6252
+ {
6253
+ "properties": {
6254
+ "controls": {
6255
+ "items": {
6256
+ "properties": {
6257
+ "macroParameterValue": {
6258
+ "maxLength": 10000,
6259
+ "type": "string",
6260
+ "fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n"
6261
+ },
6262
+ "label": {
6263
+ "$ref": "#/definitions/i18nProperty",
6232
6264
  "fieldDescription": "\n\nText which will appear inside the button\n\n"
6233
6265
  },
6234
6266
  "type": {
@@ -6286,70 +6318,6 @@
6286
6318
  "title": "ToggleGroup",
6287
6319
  "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"
6288
6320
  },
6289
- {
6290
- "properties": {
6291
- "macroParameter": {
6292
- "maxLength": 100,
6293
- "type": "string",
6294
- "fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
6295
- },
6296
- "type": {
6297
- "enum": [
6298
- "text",
6299
- "TEXT"
6300
- ],
6301
- "type": "string",
6302
- "fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
6303
- },
6304
- "key": {
6305
- "pattern": "^[a-zA-Z0-9-]+$",
6306
- "maxLength": 100,
6307
- "type": "string",
6308
- "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"
6309
- }
6310
- },
6311
- "required": [
6312
- "macroParameter",
6313
- "type",
6314
- "key"
6315
- ],
6316
- "shortClassName": "textControlBean",
6317
- "type": "object",
6318
- "title": "TextControl",
6319
- "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"
6320
- },
6321
- {
6322
- "properties": {
6323
- "label": {
6324
- "$ref": "#/definitions/i18nProperty",
6325
- "fieldDescription": "\n\nText which will appear inside the button\n\n"
6326
- },
6327
- "type": {
6328
- "enum": [
6329
- "button",
6330
- "BUTTON"
6331
- ],
6332
- "type": "string",
6333
- "fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
6334
- },
6335
- "key": {
6336
- "pattern": "^[a-zA-Z0-9-]+$",
6337
- "maxLength": 100,
6338
- "type": "string",
6339
- "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
6340
- }
6341
- },
6342
- "required": [
6343
- "label",
6344
- "type",
6345
- "key"
6346
- ],
6347
- "additionalProperties": true,
6348
- "shortClassName": "buttonControlBean",
6349
- "type": "object",
6350
- "title": "ButtonControl",
6351
- "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"
6352
- },
6353
6321
  {
6354
6322
  "properties": {
6355
6323
  "controls": {
@@ -6405,6 +6373,38 @@
6405
6373
  "type": "object",
6406
6374
  "title": "ControlGroup",
6407
6375
  "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"
6376
+ },
6377
+ {
6378
+ "properties": {
6379
+ "macroParameter": {
6380
+ "maxLength": 100,
6381
+ "type": "string",
6382
+ "fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
6383
+ },
6384
+ "type": {
6385
+ "enum": [
6386
+ "text",
6387
+ "TEXT"
6388
+ ],
6389
+ "type": "string",
6390
+ "fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
6391
+ },
6392
+ "key": {
6393
+ "pattern": "^[a-zA-Z0-9-]+$",
6394
+ "maxLength": 100,
6395
+ "type": "string",
6396
+ "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"
6397
+ }
6398
+ },
6399
+ "required": [
6400
+ "macroParameter",
6401
+ "type",
6402
+ "key"
6403
+ ],
6404
+ "shortClassName": "textControlBean",
6405
+ "type": "object",
6406
+ "title": "TextControl",
6407
+ "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"
6408
6408
  }
6409
6409
  ]
6410
6410
  },
@@ -6701,72 +6701,67 @@
6701
6701
  "anyOf": [
6702
6702
  {
6703
6703
  "properties": {
6704
- "controls": {
6705
- "items": {
6706
- "properties": {
6707
- "macroParameterValue": {
6708
- "maxLength": 10000,
6709
- "type": "string",
6710
- "fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n"
6711
- },
6712
- "label": {
6713
- "$ref": "#/definitions/i18nProperty",
6714
- "fieldDescription": "\n\nText which will appear inside the button\n\n"
6715
- },
6716
- "type": {
6717
- "enum": [
6718
- "togglebutton",
6719
- "TOGGLEBUTTON"
6720
- ],
6721
- "type": "string",
6722
- "fieldDescription": "\n\nThe type field must be set to 'togglebutton'\n\n"
6723
- },
6724
- "key": {
6725
- "pattern": "^[a-zA-Z0-9-]+$",
6726
- "maxLength": 100,
6727
- "type": "string",
6728
- "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
6729
- }
6730
- },
6731
- "required": [
6732
- "macroParameterValue",
6733
- "label",
6734
- "type",
6735
- "key"
6736
- ],
6737
- "additionalProperties": true,
6738
- "shortClassName": "macroToggleButtonControlBean",
6739
- "type": "object",
6740
- "title": "ToggleButtonControl",
6741
- "description": "\n\nDefines a toggle button which appears inside a ToggleGroup\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"type\": \"togglebutton\",\n \"macroParameterValue\": \"macroParameterValue 0\",\n \"label\": {\n \"value\": \"My Custom Control 0\"\n },\n \"key\": \"my-custom-toggle-button-0\"\n }\n\n\n"
6742
- },
6743
- "type": "array",
6744
- "fieldDescription": "\n\nToggle buttons which will appear in the toggle group\n\n"
6745
- },
6746
6704
  "macroParameter": {
6747
- "pattern": "[-_a-z0-9\\.]+",
6748
6705
  "maxLength": 100,
6749
6706
  "type": "string",
6750
- "fieldDescription": "\n\nThe macro parameter identifier used to store the toggle state.\n It must only contain lowercase alphanumeric characters, dashes, underscores, dots and must not contain any spaces.\n\n"
6707
+ "fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
6751
6708
  },
6752
6709
  "type": {
6753
6710
  "enum": [
6754
- "togglegroup",
6755
- "TOGGLEGROUP"
6711
+ "text",
6712
+ "TEXT"
6756
6713
  ],
6757
6714
  "type": "string",
6758
- "fieldDescription": "\n\nThe type field must be set to 'togglegroup'\n\n"
6715
+ "fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
6716
+ },
6717
+ "key": {
6718
+ "pattern": "^[a-zA-Z0-9-]+$",
6719
+ "maxLength": 100,
6720
+ "type": "string",
6721
+ "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"
6759
6722
  }
6760
6723
  },
6761
6724
  "required": [
6762
- "controls",
6763
6725
  "macroParameter",
6764
- "type"
6726
+ "type",
6727
+ "key"
6765
6728
  ],
6766
- "shortClassName": "macroToggleGroupBean",
6729
+ "shortClassName": "textControlBean",
6767
6730
  "type": "object",
6768
- "title": "ToggleGroup",
6769
- "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"
6731
+ "title": "TextControl",
6732
+ "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"
6733
+ },
6734
+ {
6735
+ "properties": {
6736
+ "label": {
6737
+ "$ref": "#/definitions/i18nProperty",
6738
+ "fieldDescription": "\n\nText which will appear inside the button\n\n"
6739
+ },
6740
+ "type": {
6741
+ "enum": [
6742
+ "button",
6743
+ "BUTTON"
6744
+ ],
6745
+ "type": "string",
6746
+ "fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
6747
+ },
6748
+ "key": {
6749
+ "pattern": "^[a-zA-Z0-9-]+$",
6750
+ "maxLength": 100,
6751
+ "type": "string",
6752
+ "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
6753
+ }
6754
+ },
6755
+ "required": [
6756
+ "label",
6757
+ "type",
6758
+ "key"
6759
+ ],
6760
+ "additionalProperties": true,
6761
+ "shortClassName": "buttonControlBean",
6762
+ "type": "object",
6763
+ "title": "ButtonControl",
6764
+ "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"
6770
6765
  },
6771
6766
  {
6772
6767
  "properties": {
@@ -6826,67 +6821,72 @@
6826
6821
  },
6827
6822
  {
6828
6823
  "properties": {
6824
+ "controls": {
6825
+ "items": {
6826
+ "properties": {
6827
+ "macroParameterValue": {
6828
+ "maxLength": 10000,
6829
+ "type": "string",
6830
+ "fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n"
6831
+ },
6832
+ "label": {
6833
+ "$ref": "#/definitions/i18nProperty",
6834
+ "fieldDescription": "\n\nText which will appear inside the button\n\n"
6835
+ },
6836
+ "type": {
6837
+ "enum": [
6838
+ "togglebutton",
6839
+ "TOGGLEBUTTON"
6840
+ ],
6841
+ "type": "string",
6842
+ "fieldDescription": "\n\nThe type field must be set to 'togglebutton'\n\n"
6843
+ },
6844
+ "key": {
6845
+ "pattern": "^[a-zA-Z0-9-]+$",
6846
+ "maxLength": 100,
6847
+ "type": "string",
6848
+ "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
6849
+ }
6850
+ },
6851
+ "required": [
6852
+ "macroParameterValue",
6853
+ "label",
6854
+ "type",
6855
+ "key"
6856
+ ],
6857
+ "additionalProperties": true,
6858
+ "shortClassName": "macroToggleButtonControlBean",
6859
+ "type": "object",
6860
+ "title": "ToggleButtonControl",
6861
+ "description": "\n\nDefines a toggle button which appears inside a ToggleGroup\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"type\": \"togglebutton\",\n \"macroParameterValue\": \"macroParameterValue 0\",\n \"label\": {\n \"value\": \"My Custom Control 0\"\n },\n \"key\": \"my-custom-toggle-button-0\"\n }\n\n\n"
6862
+ },
6863
+ "type": "array",
6864
+ "fieldDescription": "\n\nToggle buttons which will appear in the toggle group\n\n"
6865
+ },
6829
6866
  "macroParameter": {
6867
+ "pattern": "[-_a-z0-9\\.]+",
6830
6868
  "maxLength": 100,
6831
6869
  "type": "string",
6832
- "fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
6870
+ "fieldDescription": "\n\nThe macro parameter identifier used to store the toggle state.\n It must only contain lowercase alphanumeric characters, dashes, underscores, dots and must not contain any spaces.\n\n"
6833
6871
  },
6834
6872
  "type": {
6835
6873
  "enum": [
6836
- "text",
6837
- "TEXT"
6874
+ "togglegroup",
6875
+ "TOGGLEGROUP"
6838
6876
  ],
6839
6877
  "type": "string",
6840
- "fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
6841
- },
6842
- "key": {
6843
- "pattern": "^[a-zA-Z0-9-]+$",
6844
- "maxLength": 100,
6845
- "type": "string",
6846
- "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"
6878
+ "fieldDescription": "\n\nThe type field must be set to 'togglegroup'\n\n"
6847
6879
  }
6848
6880
  },
6849
6881
  "required": [
6882
+ "controls",
6850
6883
  "macroParameter",
6851
- "type",
6852
- "key"
6853
- ],
6854
- "shortClassName": "textControlBean",
6855
- "type": "object",
6856
- "title": "TextControl",
6857
- "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"
6858
- },
6859
- {
6860
- "properties": {
6861
- "label": {
6862
- "$ref": "#/definitions/i18nProperty",
6863
- "fieldDescription": "\n\nText which will appear inside the button\n\n"
6864
- },
6865
- "type": {
6866
- "enum": [
6867
- "button",
6868
- "BUTTON"
6869
- ],
6870
- "type": "string",
6871
- "fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
6872
- },
6873
- "key": {
6874
- "pattern": "^[a-zA-Z0-9-]+$",
6875
- "maxLength": 100,
6876
- "type": "string",
6877
- "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
6878
- }
6879
- },
6880
- "required": [
6881
- "label",
6882
- "type",
6883
- "key"
6884
+ "type"
6884
6885
  ],
6885
- "additionalProperties": true,
6886
- "shortClassName": "buttonControlBean",
6886
+ "shortClassName": "macroToggleGroupBean",
6887
6887
  "type": "object",
6888
- "title": "ButtonControl",
6889
- "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"
6888
+ "title": "ToggleGroup",
6889
+ "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"
6890
6890
  }
6891
6891
  ]
6892
6892
  },
@@ -7124,48 +7124,19 @@
7124
7124
  "anyOf": [
7125
7125
  {
7126
7126
  "properties": {
7127
- "size": {
7128
- "enum": [
7129
- "small",
7130
- "SMALL",
7131
- "medium",
7132
- "MEDIUM",
7133
- "large",
7134
- "LARGE",
7135
- "x-large",
7136
- "X-LARGE",
7137
- "fullscreen",
7138
- "FULLSCREEN",
7139
- "maximum",
7140
- "MAXIMUM"
7141
- ],
7142
- "type": "string",
7143
- "fieldDescription": "\n\nSets the size of the dialog.\n\n <p>\n This option is used instead of the 'height' and 'width' options.\n </p>\n\n"
7144
- },
7145
- "chrome": {
7146
- "type": "boolean",
7147
- "fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
7148
- "defaultValue": "true"
7149
- },
7150
- "width": {
7151
- "maxLength": 10,
7152
- "type": "string",
7153
- "fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
7154
- },
7155
- "header": {
7156
- "$ref": "#/definitions/i18nProperty",
7157
- "fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
7158
- },
7159
- "height": {
7160
- "maxLength": 10,
7127
+ "key": {
7128
+ "maxLength": 100,
7161
7129
  "type": "string",
7162
- "fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
7130
+ "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"
7163
7131
  }
7164
7132
  },
7165
- "shortClassName": "dialogOptions",
7133
+ "required": [
7134
+ "key"
7135
+ ],
7136
+ "shortClassName": "dialogModuleOptions",
7166
7137
  "type": "object",
7167
- "title": "Dialog Options",
7168
- "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"
7138
+ "title": "Dialog Module Options",
7139
+ "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"
7169
7140
  },
7170
7141
  {
7171
7142
  "properties": {
@@ -7216,19 +7187,48 @@
7216
7187
  },
7217
7188
  {
7218
7189
  "properties": {
7219
- "key": {
7220
- "maxLength": 100,
7190
+ "size": {
7191
+ "enum": [
7192
+ "small",
7193
+ "SMALL",
7194
+ "medium",
7195
+ "MEDIUM",
7196
+ "large",
7197
+ "LARGE",
7198
+ "x-large",
7199
+ "X-LARGE",
7200
+ "fullscreen",
7201
+ "FULLSCREEN",
7202
+ "maximum",
7203
+ "MAXIMUM"
7204
+ ],
7221
7205
  "type": "string",
7222
- "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"
7206
+ "fieldDescription": "\n\nSets the size of the dialog.\n\n <p>\n This option is used instead of the 'height' and 'width' options.\n </p>\n\n"
7207
+ },
7208
+ "chrome": {
7209
+ "type": "boolean",
7210
+ "fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
7211
+ "defaultValue": "true"
7212
+ },
7213
+ "width": {
7214
+ "maxLength": 10,
7215
+ "type": "string",
7216
+ "fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
7217
+ },
7218
+ "header": {
7219
+ "$ref": "#/definitions/i18nProperty",
7220
+ "fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
7221
+ },
7222
+ "height": {
7223
+ "maxLength": 10,
7224
+ "type": "string",
7225
+ "fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
7223
7226
  }
7224
7227
  },
7225
- "required": [
7226
- "key"
7227
- ],
7228
- "shortClassName": "dialogModuleOptions",
7228
+ "shortClassName": "dialogOptions",
7229
7229
  "type": "object",
7230
- "title": "Dialog Module Options",
7231
- "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"
7230
+ "title": "Dialog Options",
7231
+ "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"
7232
7232
  }
7233
7233
  ]
7234
7234
  },
@@ -7598,13 +7598,13 @@
7598
7598
  "description": "External authentication providers",
7599
7599
  "items": {
7600
7600
  "oneOf": [
7601
- {
7602
- "$ref": "#/definitions/AuthProviderPredefined",
7603
- "title": "AuthProviderPredefined"
7604
- },
7605
7601
  {
7606
7602
  "$ref": "#/definitions/AuthProviderCustom",
7607
7603
  "title": "AuthProviderCustom"
7604
+ },
7605
+ {
7606
+ "$ref": "#/definitions/AuthProviderPredefined",
7607
+ "title": "AuthProviderPredefined"
7608
7608
  }
7609
7609
  ]
7610
7610
  }
@@ -7678,21 +7678,8 @@
7678
7678
  ]
7679
7679
  },
7680
7680
  "bearerMethod": {
7681
- "type": [
7682
- "string",
7683
- "object"
7684
- ],
7685
- "additionalProperties": false,
7686
- "enum": [
7687
- "authorization-header",
7688
- "form-encoded",
7689
- "uri-query"
7690
- ],
7691
- "required": [
7692
- "type"
7693
- ],
7694
- "properties": {
7695
- "type": {
7681
+ "oneOf": [
7682
+ {
7696
7683
  "type": "string",
7697
7684
  "enum": [
7698
7685
  "authorization-header",
@@ -7700,17 +7687,34 @@
7700
7687
  "uri-query"
7701
7688
  ]
7702
7689
  },
7703
- "prefix": {
7704
- "type": "string",
7705
- "description": "Custom authorization header prefix",
7706
- "maxLength": 1000
7707
- },
7708
- "parameter": {
7709
- "type": "string",
7710
- "description": "Custom Header name or Parameter name (depending on type)",
7711
- "maxlength": 1000
7690
+ {
7691
+ "type": "object",
7692
+ "additionalProperties": false,
7693
+ "required": [
7694
+ "type"
7695
+ ],
7696
+ "properties": {
7697
+ "type": {
7698
+ "type": "string",
7699
+ "enum": [
7700
+ "authorization-header",
7701
+ "form-encoded",
7702
+ "uri-query"
7703
+ ]
7704
+ },
7705
+ "prefix": {
7706
+ "type": "string",
7707
+ "description": "Custom authorization header prefix",
7708
+ "maxLength": 1000
7709
+ },
7710
+ "parameter": {
7711
+ "type": "string",
7712
+ "description": "Custom Header name or Parameter name (depending on type)",
7713
+ "maxlength": 1000
7714
+ }
7715
+ }
7712
7716
  }
7713
- }
7717
+ ]
7714
7718
  },
7715
7719
  "clientId": {
7716
7720
  "type": "string",
@@ -8510,10 +8514,10 @@
8510
8514
  "type": "object",
8511
8515
  "anyOf": [
8512
8516
  {
8513
- "$ref": "#"
8517
+ "$ref": "#/definitions/singleCondition"
8514
8518
  },
8515
8519
  {
8516
- "$ref": "#/definitions/singleCondition"
8520
+ "$ref": "#"
8517
8521
  }
8518
8522
  ]
8519
8523
  },