@forge/manifest 3.4.0-next.7 → 3.4.0
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 +31 -0
- package/out/schema/manifest-schema.json +185 -154
- package/out/schema/manifest.d.ts +183 -167
- package/out/text/errors.d.ts +4 -1
- package/out/text/errors.d.ts.map +1 -1
- package/out/text/errors.js +4 -1
- package/out/types/module-types.d.ts +1 -0
- package/out/types/module-types.d.ts.map +1 -1
- package/out/types/module-types.js +1 -0
- package/out/validators/modules-validator.d.ts.map +1 -1
- package/out/validators/modules-validator.js +8 -3
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,36 @@
|
|
|
1
1
|
# @forge/manifest
|
|
2
2
|
|
|
3
|
+
## 3.4.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 64dd525: Make revokeToken optional in External Auth
|
|
8
|
+
- 8e2c90f: Manifest schema updated. Includes new jira:workflowCondition module
|
|
9
|
+
|
|
10
|
+
### Patch Changes
|
|
11
|
+
|
|
12
|
+
- 1c6c578: Add jiraEntityProperty values validation
|
|
13
|
+
- 8b4fede: Update manifest definitions
|
|
14
|
+
- 54bf134: Update manifest definitions
|
|
15
|
+
- 10f147f: Update manifest definitions
|
|
16
|
+
- 2484683: Update manifest definitions
|
|
17
|
+
- 1a8a4bb: Update manifest definitions
|
|
18
|
+
- e0a44d4: Update manifest definitions
|
|
19
|
+
- 19820d3: Update manifest definitions
|
|
20
|
+
- 1ca8bbc: Update manifest definitions
|
|
21
|
+
|
|
22
|
+
## 3.4.0-next.9
|
|
23
|
+
|
|
24
|
+
### Patch Changes
|
|
25
|
+
|
|
26
|
+
- 19820d3: Update manifest definitions
|
|
27
|
+
|
|
28
|
+
## 3.4.0-next.8
|
|
29
|
+
|
|
30
|
+
### Minor Changes
|
|
31
|
+
|
|
32
|
+
- 8e2c90f: Manifest schema updated. Includes new jira:workflowCondition module
|
|
33
|
+
|
|
3
34
|
## 3.4.0-next.7
|
|
4
35
|
|
|
5
36
|
### Patch Changes
|
|
@@ -3892,6 +3892,37 @@
|
|
|
3892
3892
|
},
|
|
3893
3893
|
"minItems": 1
|
|
3894
3894
|
},
|
|
3895
|
+
"jira:workflowCondition": {
|
|
3896
|
+
"type": "array",
|
|
3897
|
+
"items": {
|
|
3898
|
+
"type": "object",
|
|
3899
|
+
"properties": {
|
|
3900
|
+
"name": {
|
|
3901
|
+
"minLength": 1,
|
|
3902
|
+
"maxLength": 255,
|
|
3903
|
+
"type": "string"
|
|
3904
|
+
},
|
|
3905
|
+
"description": {
|
|
3906
|
+
"minLength": 1,
|
|
3907
|
+
"maxLength": 1000,
|
|
3908
|
+
"type": "string"
|
|
3909
|
+
},
|
|
3910
|
+
"expression": {
|
|
3911
|
+
"type": "string"
|
|
3912
|
+
},
|
|
3913
|
+
"key": {
|
|
3914
|
+
"$ref": "#/definitions/ModuleKeySchema"
|
|
3915
|
+
}
|
|
3916
|
+
},
|
|
3917
|
+
"required": [
|
|
3918
|
+
"description",
|
|
3919
|
+
"expression",
|
|
3920
|
+
"name",
|
|
3921
|
+
"key"
|
|
3922
|
+
]
|
|
3923
|
+
},
|
|
3924
|
+
"minItems": 1
|
|
3925
|
+
},
|
|
3895
3926
|
"compass:adminPage": {
|
|
3896
3927
|
"type": "array",
|
|
3897
3928
|
"items": {
|
|
@@ -7567,10 +7598,10 @@
|
|
|
7567
7598
|
"type": "object",
|
|
7568
7599
|
"anyOf": [
|
|
7569
7600
|
{
|
|
7570
|
-
"$ref": "#/definitions/
|
|
7601
|
+
"$ref": "#/definitions/singleCondition"
|
|
7571
7602
|
},
|
|
7572
7603
|
{
|
|
7573
|
-
"$ref": "#/definitions/
|
|
7604
|
+
"$ref": "#/definitions/compositeCondition"
|
|
7574
7605
|
}
|
|
7575
7606
|
]
|
|
7576
7607
|
},
|
|
@@ -7757,10 +7788,10 @@
|
|
|
7757
7788
|
"type": "object",
|
|
7758
7789
|
"anyOf": [
|
|
7759
7790
|
{
|
|
7760
|
-
"$ref": "#/definitions/
|
|
7791
|
+
"$ref": "#/definitions/compositeCondition"
|
|
7761
7792
|
},
|
|
7762
7793
|
{
|
|
7763
|
-
"$ref": "#/definitions/
|
|
7794
|
+
"$ref": "#/definitions/singleCondition"
|
|
7764
7795
|
}
|
|
7765
7796
|
]
|
|
7766
7797
|
},
|
|
@@ -7815,10 +7846,10 @@
|
|
|
7815
7846
|
"type": "object",
|
|
7816
7847
|
"anyOf": [
|
|
7817
7848
|
{
|
|
7818
|
-
"$ref": "#/definitions/
|
|
7849
|
+
"$ref": "#/definitions/compositeCondition"
|
|
7819
7850
|
},
|
|
7820
7851
|
{
|
|
7821
|
-
"$ref": "#/definitions/
|
|
7852
|
+
"$ref": "#/definitions/singleCondition"
|
|
7822
7853
|
}
|
|
7823
7854
|
]
|
|
7824
7855
|
},
|
|
@@ -7873,10 +7904,10 @@
|
|
|
7873
7904
|
"type": "object",
|
|
7874
7905
|
"anyOf": [
|
|
7875
7906
|
{
|
|
7876
|
-
"$ref": "#/definitions/
|
|
7907
|
+
"$ref": "#/definitions/compositeCondition"
|
|
7877
7908
|
},
|
|
7878
7909
|
{
|
|
7879
|
-
"$ref": "#/definitions/
|
|
7910
|
+
"$ref": "#/definitions/singleCondition"
|
|
7880
7911
|
}
|
|
7881
7912
|
]
|
|
7882
7913
|
},
|
|
@@ -7991,6 +8022,22 @@
|
|
|
7991
8022
|
"title": "Dialog Options",
|
|
7992
8023
|
"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"
|
|
7993
8024
|
},
|
|
8025
|
+
{
|
|
8026
|
+
"properties": {
|
|
8027
|
+
"key": {
|
|
8028
|
+
"maxLength": 100,
|
|
8029
|
+
"type": "string",
|
|
8030
|
+
"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"
|
|
8031
|
+
}
|
|
8032
|
+
},
|
|
8033
|
+
"required": [
|
|
8034
|
+
"key"
|
|
8035
|
+
],
|
|
8036
|
+
"shortClassName": "dialogModuleOptions",
|
|
8037
|
+
"type": "object",
|
|
8038
|
+
"title": "Dialog Module Options",
|
|
8039
|
+
"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"
|
|
8040
|
+
},
|
|
7994
8041
|
{
|
|
7995
8042
|
"properties": {
|
|
7996
8043
|
"offsetX": {
|
|
@@ -8037,22 +8084,6 @@
|
|
|
8037
8084
|
"type": "object",
|
|
8038
8085
|
"title": "Inline Dialog Options",
|
|
8039
8086
|
"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"
|
|
8040
|
-
},
|
|
8041
|
-
{
|
|
8042
|
-
"properties": {
|
|
8043
|
-
"key": {
|
|
8044
|
-
"maxLength": 100,
|
|
8045
|
-
"type": "string",
|
|
8046
|
-
"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"
|
|
8047
|
-
}
|
|
8048
|
-
},
|
|
8049
|
-
"required": [
|
|
8050
|
-
"key"
|
|
8051
|
-
],
|
|
8052
|
-
"shortClassName": "dialogModuleOptions",
|
|
8053
|
-
"type": "object",
|
|
8054
|
-
"title": "Dialog Module Options",
|
|
8055
|
-
"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"
|
|
8056
8087
|
}
|
|
8057
8088
|
]
|
|
8058
8089
|
},
|
|
@@ -8109,6 +8140,33 @@
|
|
|
8109
8140
|
"items": {
|
|
8110
8141
|
"type": "object",
|
|
8111
8142
|
"anyOf": [
|
|
8143
|
+
{
|
|
8144
|
+
"properties": {
|
|
8145
|
+
"condition": {
|
|
8146
|
+
"maxLength": 100,
|
|
8147
|
+
"type": "string",
|
|
8148
|
+
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
8149
|
+
},
|
|
8150
|
+
"invert": {
|
|
8151
|
+
"type": "boolean",
|
|
8152
|
+
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
8153
|
+
"defaultValue": "false"
|
|
8154
|
+
},
|
|
8155
|
+
"params": {
|
|
8156
|
+
"additionalProperties": true,
|
|
8157
|
+
"type": "object",
|
|
8158
|
+
"fieldTitle": "Object",
|
|
8159
|
+
"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"
|
|
8160
|
+
}
|
|
8161
|
+
},
|
|
8162
|
+
"required": [
|
|
8163
|
+
"condition"
|
|
8164
|
+
],
|
|
8165
|
+
"shortClassName": "singleConditionBean",
|
|
8166
|
+
"type": "object",
|
|
8167
|
+
"title": "Single Condition",
|
|
8168
|
+
"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"
|
|
8169
|
+
},
|
|
8112
8170
|
{
|
|
8113
8171
|
"properties": {
|
|
8114
8172
|
"conditions": {
|
|
@@ -8116,10 +8174,10 @@
|
|
|
8116
8174
|
"type": "object",
|
|
8117
8175
|
"anyOf": [
|
|
8118
8176
|
{
|
|
8119
|
-
"$ref": "
|
|
8177
|
+
"$ref": "#"
|
|
8120
8178
|
},
|
|
8121
8179
|
{
|
|
8122
|
-
"$ref": "
|
|
8180
|
+
"$ref": "#/definitions/singleCondition"
|
|
8123
8181
|
}
|
|
8124
8182
|
]
|
|
8125
8183
|
},
|
|
@@ -8141,33 +8199,6 @@
|
|
|
8141
8199
|
"type": "object",
|
|
8142
8200
|
"title": "Composite Condition",
|
|
8143
8201
|
"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"
|
|
8144
|
-
},
|
|
8145
|
-
{
|
|
8146
|
-
"properties": {
|
|
8147
|
-
"condition": {
|
|
8148
|
-
"maxLength": 100,
|
|
8149
|
-
"type": "string",
|
|
8150
|
-
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
8151
|
-
},
|
|
8152
|
-
"invert": {
|
|
8153
|
-
"type": "boolean",
|
|
8154
|
-
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
8155
|
-
"defaultValue": "false"
|
|
8156
|
-
},
|
|
8157
|
-
"params": {
|
|
8158
|
-
"additionalProperties": true,
|
|
8159
|
-
"type": "object",
|
|
8160
|
-
"fieldTitle": "Object",
|
|
8161
|
-
"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"
|
|
8162
|
-
}
|
|
8163
|
-
},
|
|
8164
|
-
"required": [
|
|
8165
|
-
"condition"
|
|
8166
|
-
],
|
|
8167
|
-
"shortClassName": "singleConditionBean",
|
|
8168
|
-
"type": "object",
|
|
8169
|
-
"title": "Single Condition",
|
|
8170
|
-
"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"
|
|
8171
8202
|
}
|
|
8172
8203
|
]
|
|
8173
8204
|
},
|
|
@@ -8221,10 +8252,10 @@
|
|
|
8221
8252
|
"type": "object",
|
|
8222
8253
|
"anyOf": [
|
|
8223
8254
|
{
|
|
8224
|
-
"$ref": "#/definitions/
|
|
8255
|
+
"$ref": "#/definitions/singleCondition"
|
|
8225
8256
|
},
|
|
8226
8257
|
{
|
|
8227
|
-
"$ref": "#/definitions/
|
|
8258
|
+
"$ref": "#/definitions/compositeCondition"
|
|
8228
8259
|
}
|
|
8229
8260
|
]
|
|
8230
8261
|
},
|
|
@@ -8706,35 +8737,72 @@
|
|
|
8706
8737
|
"anyOf": [
|
|
8707
8738
|
{
|
|
8708
8739
|
"properties": {
|
|
8740
|
+
"controls": {
|
|
8741
|
+
"items": {
|
|
8742
|
+
"properties": {
|
|
8743
|
+
"macroParameterValue": {
|
|
8744
|
+
"maxLength": 10000,
|
|
8745
|
+
"type": "string",
|
|
8746
|
+
"fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n"
|
|
8747
|
+
},
|
|
8748
|
+
"label": {
|
|
8749
|
+
"$ref": "#/definitions/i18nProperty",
|
|
8750
|
+
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
8751
|
+
},
|
|
8752
|
+
"type": {
|
|
8753
|
+
"enum": [
|
|
8754
|
+
"togglebutton",
|
|
8755
|
+
"TOGGLEBUTTON"
|
|
8756
|
+
],
|
|
8757
|
+
"type": "string",
|
|
8758
|
+
"fieldDescription": "\n\nThe type field must be set to 'togglebutton'\n\n"
|
|
8759
|
+
},
|
|
8760
|
+
"key": {
|
|
8761
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
8762
|
+
"maxLength": 100,
|
|
8763
|
+
"type": "string",
|
|
8764
|
+
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
8765
|
+
}
|
|
8766
|
+
},
|
|
8767
|
+
"required": [
|
|
8768
|
+
"macroParameterValue",
|
|
8769
|
+
"label",
|
|
8770
|
+
"type",
|
|
8771
|
+
"key"
|
|
8772
|
+
],
|
|
8773
|
+
"additionalProperties": true,
|
|
8774
|
+
"shortClassName": "macroToggleButtonControlBean",
|
|
8775
|
+
"type": "object",
|
|
8776
|
+
"title": "ToggleButtonControl",
|
|
8777
|
+
"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"
|
|
8778
|
+
},
|
|
8779
|
+
"type": "array",
|
|
8780
|
+
"fieldDescription": "\n\nToggle buttons which will appear in the toggle group\n\n"
|
|
8781
|
+
},
|
|
8709
8782
|
"macroParameter": {
|
|
8783
|
+
"pattern": "[-_a-z0-9\\.]+",
|
|
8710
8784
|
"maxLength": 100,
|
|
8711
8785
|
"type": "string",
|
|
8712
|
-
"fieldDescription": "\n\nThe
|
|
8786
|
+
"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"
|
|
8713
8787
|
},
|
|
8714
8788
|
"type": {
|
|
8715
8789
|
"enum": [
|
|
8716
|
-
"
|
|
8717
|
-
"
|
|
8790
|
+
"togglegroup",
|
|
8791
|
+
"TOGGLEGROUP"
|
|
8718
8792
|
],
|
|
8719
8793
|
"type": "string",
|
|
8720
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
8721
|
-
},
|
|
8722
|
-
"key": {
|
|
8723
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
8724
|
-
"maxLength": 100,
|
|
8725
|
-
"type": "string",
|
|
8726
|
-
"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"
|
|
8794
|
+
"fieldDescription": "\n\nThe type field must be set to 'togglegroup'\n\n"
|
|
8727
8795
|
}
|
|
8728
8796
|
},
|
|
8729
8797
|
"required": [
|
|
8798
|
+
"controls",
|
|
8730
8799
|
"macroParameter",
|
|
8731
|
-
"type"
|
|
8732
|
-
"key"
|
|
8800
|
+
"type"
|
|
8733
8801
|
],
|
|
8734
|
-
"shortClassName": "
|
|
8802
|
+
"shortClassName": "macroToggleGroupBean",
|
|
8735
8803
|
"type": "object",
|
|
8736
|
-
"title": "
|
|
8737
|
-
"description": "\n\nDefines a
|
|
8804
|
+
"title": "ToggleGroup",
|
|
8805
|
+
"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"
|
|
8738
8806
|
},
|
|
8739
8807
|
{
|
|
8740
8808
|
"properties": {
|
|
@@ -8794,104 +8862,67 @@
|
|
|
8794
8862
|
},
|
|
8795
8863
|
{
|
|
8796
8864
|
"properties": {
|
|
8797
|
-
"
|
|
8798
|
-
"
|
|
8799
|
-
"
|
|
8865
|
+
"macroParameter": {
|
|
8866
|
+
"maxLength": 100,
|
|
8867
|
+
"type": "string",
|
|
8868
|
+
"fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
|
|
8800
8869
|
},
|
|
8801
8870
|
"type": {
|
|
8802
8871
|
"enum": [
|
|
8803
|
-
"
|
|
8804
|
-
"
|
|
8872
|
+
"text",
|
|
8873
|
+
"TEXT"
|
|
8805
8874
|
],
|
|
8806
8875
|
"type": "string",
|
|
8807
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
8876
|
+
"fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
|
|
8808
8877
|
},
|
|
8809
8878
|
"key": {
|
|
8810
8879
|
"pattern": "^[a-zA-Z0-9-]+$",
|
|
8811
8880
|
"maxLength": 100,
|
|
8812
8881
|
"type": "string",
|
|
8813
|
-
"fieldDescription": "\n\nA key to identify the
|
|
8882
|
+
"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"
|
|
8814
8883
|
}
|
|
8815
8884
|
},
|
|
8816
8885
|
"required": [
|
|
8817
|
-
"
|
|
8886
|
+
"macroParameter",
|
|
8818
8887
|
"type",
|
|
8819
8888
|
"key"
|
|
8820
8889
|
],
|
|
8821
|
-
"
|
|
8822
|
-
"shortClassName": "buttonControlBean",
|
|
8890
|
+
"shortClassName": "textControlBean",
|
|
8823
8891
|
"type": "object",
|
|
8824
|
-
"title": "
|
|
8825
|
-
"description": "\n\nDefines a
|
|
8892
|
+
"title": "TextControl",
|
|
8893
|
+
"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"
|
|
8826
8894
|
},
|
|
8827
8895
|
{
|
|
8828
8896
|
"properties": {
|
|
8829
|
-
"
|
|
8830
|
-
"
|
|
8831
|
-
|
|
8832
|
-
"macroParameterValue": {
|
|
8833
|
-
"maxLength": 10000,
|
|
8834
|
-
"type": "string",
|
|
8835
|
-
"fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n"
|
|
8836
|
-
},
|
|
8837
|
-
"label": {
|
|
8838
|
-
"$ref": "#/definitions/i18nProperty",
|
|
8839
|
-
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
8840
|
-
},
|
|
8841
|
-
"type": {
|
|
8842
|
-
"enum": [
|
|
8843
|
-
"togglebutton",
|
|
8844
|
-
"TOGGLEBUTTON"
|
|
8845
|
-
],
|
|
8846
|
-
"type": "string",
|
|
8847
|
-
"fieldDescription": "\n\nThe type field must be set to 'togglebutton'\n\n"
|
|
8848
|
-
},
|
|
8849
|
-
"key": {
|
|
8850
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
8851
|
-
"maxLength": 100,
|
|
8852
|
-
"type": "string",
|
|
8853
|
-
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
8854
|
-
}
|
|
8855
|
-
},
|
|
8856
|
-
"required": [
|
|
8857
|
-
"macroParameterValue",
|
|
8858
|
-
"label",
|
|
8859
|
-
"type",
|
|
8860
|
-
"key"
|
|
8861
|
-
],
|
|
8862
|
-
"additionalProperties": true,
|
|
8863
|
-
"shortClassName": "macroToggleButtonControlBean",
|
|
8864
|
-
"type": "object",
|
|
8865
|
-
"title": "ToggleButtonControl",
|
|
8866
|
-
"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"
|
|
8867
|
-
},
|
|
8868
|
-
"type": "array",
|
|
8869
|
-
"fieldDescription": "\n\nToggle buttons which will appear in the toggle group\n\n"
|
|
8870
|
-
},
|
|
8871
|
-
"macroParameter": {
|
|
8872
|
-
"pattern": "[-_a-z0-9\\.]+",
|
|
8873
|
-
"maxLength": 100,
|
|
8874
|
-
"type": "string",
|
|
8875
|
-
"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"
|
|
8897
|
+
"label": {
|
|
8898
|
+
"$ref": "#/definitions/i18nProperty",
|
|
8899
|
+
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
8876
8900
|
},
|
|
8877
8901
|
"type": {
|
|
8878
8902
|
"enum": [
|
|
8879
|
-
"
|
|
8880
|
-
"
|
|
8903
|
+
"button",
|
|
8904
|
+
"BUTTON"
|
|
8881
8905
|
],
|
|
8882
8906
|
"type": "string",
|
|
8883
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
8907
|
+
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
8908
|
+
},
|
|
8909
|
+
"key": {
|
|
8910
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
8911
|
+
"maxLength": 100,
|
|
8912
|
+
"type": "string",
|
|
8913
|
+
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
8884
8914
|
}
|
|
8885
8915
|
},
|
|
8886
8916
|
"required": [
|
|
8887
|
-
"
|
|
8888
|
-
"
|
|
8889
|
-
"
|
|
8917
|
+
"label",
|
|
8918
|
+
"type",
|
|
8919
|
+
"key"
|
|
8890
8920
|
],
|
|
8891
|
-
"
|
|
8921
|
+
"additionalProperties": true,
|
|
8922
|
+
"shortClassName": "buttonControlBean",
|
|
8892
8923
|
"type": "object",
|
|
8893
|
-
"title": "
|
|
8894
|
-
"description": "\n\nDefines a
|
|
8924
|
+
"title": "ButtonControl",
|
|
8925
|
+
"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"
|
|
8895
8926
|
}
|
|
8896
8927
|
]
|
|
8897
8928
|
},
|
|
@@ -9609,22 +9640,6 @@
|
|
|
9609
9640
|
"type": "object",
|
|
9610
9641
|
"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",
|
|
9611
9642
|
"anyOf": [
|
|
9612
|
-
{
|
|
9613
|
-
"properties": {
|
|
9614
|
-
"key": {
|
|
9615
|
-
"maxLength": 100,
|
|
9616
|
-
"type": "string",
|
|
9617
|
-
"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"
|
|
9618
|
-
}
|
|
9619
|
-
},
|
|
9620
|
-
"required": [
|
|
9621
|
-
"key"
|
|
9622
|
-
],
|
|
9623
|
-
"shortClassName": "dialogModuleOptions",
|
|
9624
|
-
"type": "object",
|
|
9625
|
-
"title": "Dialog Module Options",
|
|
9626
|
-
"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"
|
|
9627
|
-
},
|
|
9628
9643
|
{
|
|
9629
9644
|
"properties": {
|
|
9630
9645
|
"size": {
|
|
@@ -9716,6 +9731,22 @@
|
|
|
9716
9731
|
"type": "object",
|
|
9717
9732
|
"title": "Inline Dialog Options",
|
|
9718
9733
|
"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"
|
|
9734
|
+
},
|
|
9735
|
+
{
|
|
9736
|
+
"properties": {
|
|
9737
|
+
"key": {
|
|
9738
|
+
"maxLength": 100,
|
|
9739
|
+
"type": "string",
|
|
9740
|
+
"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"
|
|
9741
|
+
}
|
|
9742
|
+
},
|
|
9743
|
+
"required": [
|
|
9744
|
+
"key"
|
|
9745
|
+
],
|
|
9746
|
+
"shortClassName": "dialogModuleOptions",
|
|
9747
|
+
"type": "object",
|
|
9748
|
+
"title": "Dialog Module Options",
|
|
9749
|
+
"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"
|
|
9719
9750
|
}
|
|
9720
9751
|
]
|
|
9721
9752
|
},
|