@forge/manifest 3.3.1-next.3 → 3.4.0-next.4
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 +10 -0
- package/out/schema/manifest-schema.json +232 -233
- package/out/schema/manifest.d.ts +225 -225
- package/out/scopes/shipyard-scopes.json +18 -0
- package/out/validators/providers-validator.d.ts +2 -1
- package/out/validators/providers-validator.d.ts.map +1 -1
- package/out/validators/providers-validator.js +13 -9
- package/package.json +1 -1
|
@@ -7501,10 +7501,10 @@
|
|
|
7501
7501
|
"type": "object",
|
|
7502
7502
|
"anyOf": [
|
|
7503
7503
|
{
|
|
7504
|
-
"$ref": "#/definitions/
|
|
7504
|
+
"$ref": "#/definitions/singleCondition"
|
|
7505
7505
|
},
|
|
7506
7506
|
{
|
|
7507
|
-
"$ref": "#/definitions/
|
|
7507
|
+
"$ref": "#/definitions/compositeCondition"
|
|
7508
7508
|
}
|
|
7509
7509
|
]
|
|
7510
7510
|
},
|
|
@@ -7627,10 +7627,10 @@
|
|
|
7627
7627
|
"type": "object",
|
|
7628
7628
|
"anyOf": [
|
|
7629
7629
|
{
|
|
7630
|
-
"$ref": "#/definitions/
|
|
7630
|
+
"$ref": "#/definitions/compositeCondition"
|
|
7631
7631
|
},
|
|
7632
7632
|
{
|
|
7633
|
-
"$ref": "#/definitions/
|
|
7633
|
+
"$ref": "#/definitions/singleCondition"
|
|
7634
7634
|
}
|
|
7635
7635
|
]
|
|
7636
7636
|
},
|
|
@@ -7749,10 +7749,10 @@
|
|
|
7749
7749
|
"type": "object",
|
|
7750
7750
|
"anyOf": [
|
|
7751
7751
|
{
|
|
7752
|
-
"$ref": "#/definitions/
|
|
7752
|
+
"$ref": "#/definitions/compositeCondition"
|
|
7753
7753
|
},
|
|
7754
7754
|
{
|
|
7755
|
-
"$ref": "#/definitions/
|
|
7755
|
+
"$ref": "#/definitions/singleCondition"
|
|
7756
7756
|
}
|
|
7757
7757
|
]
|
|
7758
7758
|
},
|
|
@@ -7880,22 +7880,6 @@
|
|
|
7880
7880
|
"type": "object",
|
|
7881
7881
|
"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",
|
|
7882
7882
|
"anyOf": [
|
|
7883
|
-
{
|
|
7884
|
-
"properties": {
|
|
7885
|
-
"key": {
|
|
7886
|
-
"maxLength": 100,
|
|
7887
|
-
"type": "string",
|
|
7888
|
-
"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"
|
|
7889
|
-
}
|
|
7890
|
-
},
|
|
7891
|
-
"required": [
|
|
7892
|
-
"key"
|
|
7893
|
-
],
|
|
7894
|
-
"shortClassName": "dialogModuleOptions",
|
|
7895
|
-
"type": "object",
|
|
7896
|
-
"title": "Dialog Module Options",
|
|
7897
|
-
"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"
|
|
7898
|
-
},
|
|
7899
7883
|
{
|
|
7900
7884
|
"properties": {
|
|
7901
7885
|
"size": {
|
|
@@ -7987,6 +7971,22 @@
|
|
|
7987
7971
|
"type": "object",
|
|
7988
7972
|
"title": "Inline Dialog Options",
|
|
7989
7973
|
"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"
|
|
7974
|
+
},
|
|
7975
|
+
{
|
|
7976
|
+
"properties": {
|
|
7977
|
+
"key": {
|
|
7978
|
+
"maxLength": 100,
|
|
7979
|
+
"type": "string",
|
|
7980
|
+
"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"
|
|
7981
|
+
}
|
|
7982
|
+
},
|
|
7983
|
+
"required": [
|
|
7984
|
+
"key"
|
|
7985
|
+
],
|
|
7986
|
+
"shortClassName": "dialogModuleOptions",
|
|
7987
|
+
"type": "object",
|
|
7988
|
+
"title": "Dialog Module Options",
|
|
7989
|
+
"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"
|
|
7990
7990
|
}
|
|
7991
7991
|
]
|
|
7992
7992
|
},
|
|
@@ -8077,10 +8077,10 @@
|
|
|
8077
8077
|
"type": "object",
|
|
8078
8078
|
"anyOf": [
|
|
8079
8079
|
{
|
|
8080
|
-
"$ref": "
|
|
8080
|
+
"$ref": "#"
|
|
8081
8081
|
},
|
|
8082
8082
|
{
|
|
8083
|
-
"$ref": "
|
|
8083
|
+
"$ref": "#/definitions/singleCondition"
|
|
8084
8084
|
}
|
|
8085
8085
|
]
|
|
8086
8086
|
},
|
|
@@ -8155,10 +8155,10 @@
|
|
|
8155
8155
|
"type": "object",
|
|
8156
8156
|
"anyOf": [
|
|
8157
8157
|
{
|
|
8158
|
-
"$ref": "#/definitions/
|
|
8158
|
+
"$ref": "#/definitions/singleCondition"
|
|
8159
8159
|
},
|
|
8160
8160
|
{
|
|
8161
|
-
"$ref": "#/definitions/
|
|
8161
|
+
"$ref": "#/definitions/compositeCondition"
|
|
8162
8162
|
}
|
|
8163
8163
|
]
|
|
8164
8164
|
},
|
|
@@ -8306,6 +8306,33 @@
|
|
|
8306
8306
|
"items": {
|
|
8307
8307
|
"type": "object",
|
|
8308
8308
|
"anyOf": [
|
|
8309
|
+
{
|
|
8310
|
+
"properties": {
|
|
8311
|
+
"condition": {
|
|
8312
|
+
"maxLength": 100,
|
|
8313
|
+
"type": "string",
|
|
8314
|
+
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
8315
|
+
},
|
|
8316
|
+
"invert": {
|
|
8317
|
+
"type": "boolean",
|
|
8318
|
+
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
8319
|
+
"defaultValue": "false"
|
|
8320
|
+
},
|
|
8321
|
+
"params": {
|
|
8322
|
+
"additionalProperties": true,
|
|
8323
|
+
"type": "object",
|
|
8324
|
+
"fieldTitle": "Object",
|
|
8325
|
+
"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"
|
|
8326
|
+
}
|
|
8327
|
+
},
|
|
8328
|
+
"required": [
|
|
8329
|
+
"condition"
|
|
8330
|
+
],
|
|
8331
|
+
"shortClassName": "singleConditionBean",
|
|
8332
|
+
"type": "object",
|
|
8333
|
+
"title": "Single Condition",
|
|
8334
|
+
"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"
|
|
8335
|
+
},
|
|
8309
8336
|
{
|
|
8310
8337
|
"properties": {
|
|
8311
8338
|
"conditions": {
|
|
@@ -8338,33 +8365,6 @@
|
|
|
8338
8365
|
"type": "object",
|
|
8339
8366
|
"title": "Composite Condition",
|
|
8340
8367
|
"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"
|
|
8341
|
-
},
|
|
8342
|
-
{
|
|
8343
|
-
"properties": {
|
|
8344
|
-
"condition": {
|
|
8345
|
-
"maxLength": 100,
|
|
8346
|
-
"type": "string",
|
|
8347
|
-
"fieldDescription": "\n\nA string indicating the name of the condition\n\n"
|
|
8348
|
-
},
|
|
8349
|
-
"invert": {
|
|
8350
|
-
"type": "boolean",
|
|
8351
|
-
"fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
|
|
8352
|
-
"defaultValue": "false"
|
|
8353
|
-
},
|
|
8354
|
-
"params": {
|
|
8355
|
-
"additionalProperties": true,
|
|
8356
|
-
"type": "object",
|
|
8357
|
-
"fieldTitle": "Object",
|
|
8358
|
-
"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"
|
|
8359
|
-
}
|
|
8360
|
-
},
|
|
8361
|
-
"required": [
|
|
8362
|
-
"condition"
|
|
8363
|
-
],
|
|
8364
|
-
"shortClassName": "singleConditionBean",
|
|
8365
|
-
"type": "object",
|
|
8366
|
-
"title": "Single Condition",
|
|
8367
|
-
"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"
|
|
8368
8368
|
}
|
|
8369
8369
|
]
|
|
8370
8370
|
},
|
|
@@ -8694,70 +8694,6 @@
|
|
|
8694
8694
|
"title": "ControlGroup",
|
|
8695
8695
|
"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"
|
|
8696
8696
|
},
|
|
8697
|
-
{
|
|
8698
|
-
"properties": {
|
|
8699
|
-
"macroParameter": {
|
|
8700
|
-
"maxLength": 100,
|
|
8701
|
-
"type": "string",
|
|
8702
|
-
"fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
|
|
8703
|
-
},
|
|
8704
|
-
"type": {
|
|
8705
|
-
"enum": [
|
|
8706
|
-
"text",
|
|
8707
|
-
"TEXT"
|
|
8708
|
-
],
|
|
8709
|
-
"type": "string",
|
|
8710
|
-
"fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
|
|
8711
|
-
},
|
|
8712
|
-
"key": {
|
|
8713
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
8714
|
-
"maxLength": 100,
|
|
8715
|
-
"type": "string",
|
|
8716
|
-
"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"
|
|
8717
|
-
}
|
|
8718
|
-
},
|
|
8719
|
-
"required": [
|
|
8720
|
-
"macroParameter",
|
|
8721
|
-
"type",
|
|
8722
|
-
"key"
|
|
8723
|
-
],
|
|
8724
|
-
"shortClassName": "textControlBean",
|
|
8725
|
-
"type": "object",
|
|
8726
|
-
"title": "TextControl",
|
|
8727
|
-
"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"
|
|
8728
|
-
},
|
|
8729
|
-
{
|
|
8730
|
-
"properties": {
|
|
8731
|
-
"label": {
|
|
8732
|
-
"$ref": "#/definitions/i18nProperty",
|
|
8733
|
-
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
8734
|
-
},
|
|
8735
|
-
"type": {
|
|
8736
|
-
"enum": [
|
|
8737
|
-
"button",
|
|
8738
|
-
"BUTTON"
|
|
8739
|
-
],
|
|
8740
|
-
"type": "string",
|
|
8741
|
-
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
8742
|
-
},
|
|
8743
|
-
"key": {
|
|
8744
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
8745
|
-
"maxLength": 100,
|
|
8746
|
-
"type": "string",
|
|
8747
|
-
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
8748
|
-
}
|
|
8749
|
-
},
|
|
8750
|
-
"required": [
|
|
8751
|
-
"label",
|
|
8752
|
-
"type",
|
|
8753
|
-
"key"
|
|
8754
|
-
],
|
|
8755
|
-
"additionalProperties": true,
|
|
8756
|
-
"shortClassName": "buttonControlBean",
|
|
8757
|
-
"type": "object",
|
|
8758
|
-
"title": "ButtonControl",
|
|
8759
|
-
"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"
|
|
8760
|
-
},
|
|
8761
8697
|
{
|
|
8762
8698
|
"properties": {
|
|
8763
8699
|
"controls": {
|
|
@@ -8826,6 +8762,70 @@
|
|
|
8826
8762
|
"type": "object",
|
|
8827
8763
|
"title": "ToggleGroup",
|
|
8828
8764
|
"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"
|
|
8765
|
+
},
|
|
8766
|
+
{
|
|
8767
|
+
"properties": {
|
|
8768
|
+
"macroParameter": {
|
|
8769
|
+
"maxLength": 100,
|
|
8770
|
+
"type": "string",
|
|
8771
|
+
"fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
|
|
8772
|
+
},
|
|
8773
|
+
"type": {
|
|
8774
|
+
"enum": [
|
|
8775
|
+
"text",
|
|
8776
|
+
"TEXT"
|
|
8777
|
+
],
|
|
8778
|
+
"type": "string",
|
|
8779
|
+
"fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
|
|
8780
|
+
},
|
|
8781
|
+
"key": {
|
|
8782
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
8783
|
+
"maxLength": 100,
|
|
8784
|
+
"type": "string",
|
|
8785
|
+
"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"
|
|
8786
|
+
}
|
|
8787
|
+
},
|
|
8788
|
+
"required": [
|
|
8789
|
+
"macroParameter",
|
|
8790
|
+
"type",
|
|
8791
|
+
"key"
|
|
8792
|
+
],
|
|
8793
|
+
"shortClassName": "textControlBean",
|
|
8794
|
+
"type": "object",
|
|
8795
|
+
"title": "TextControl",
|
|
8796
|
+
"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"
|
|
8797
|
+
},
|
|
8798
|
+
{
|
|
8799
|
+
"properties": {
|
|
8800
|
+
"label": {
|
|
8801
|
+
"$ref": "#/definitions/i18nProperty",
|
|
8802
|
+
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
8803
|
+
},
|
|
8804
|
+
"type": {
|
|
8805
|
+
"enum": [
|
|
8806
|
+
"button",
|
|
8807
|
+
"BUTTON"
|
|
8808
|
+
],
|
|
8809
|
+
"type": "string",
|
|
8810
|
+
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
8811
|
+
},
|
|
8812
|
+
"key": {
|
|
8813
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
8814
|
+
"maxLength": 100,
|
|
8815
|
+
"type": "string",
|
|
8816
|
+
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
8817
|
+
}
|
|
8818
|
+
},
|
|
8819
|
+
"required": [
|
|
8820
|
+
"label",
|
|
8821
|
+
"type",
|
|
8822
|
+
"key"
|
|
8823
|
+
],
|
|
8824
|
+
"additionalProperties": true,
|
|
8825
|
+
"shortClassName": "buttonControlBean",
|
|
8826
|
+
"type": "object",
|
|
8827
|
+
"title": "ButtonControl",
|
|
8828
|
+
"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"
|
|
8829
8829
|
}
|
|
8830
8830
|
]
|
|
8831
8831
|
},
|
|
@@ -9120,54 +9120,27 @@
|
|
|
9120
9120
|
"items": {
|
|
9121
9121
|
"type": "object",
|
|
9122
9122
|
"anyOf": [
|
|
9123
|
-
{
|
|
9124
|
-
"properties": {
|
|
9125
|
-
"macroParameter": {
|
|
9126
|
-
"maxLength": 100,
|
|
9127
|
-
"type": "string",
|
|
9128
|
-
"fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
|
|
9129
|
-
},
|
|
9130
|
-
"type": {
|
|
9131
|
-
"enum": [
|
|
9132
|
-
"text",
|
|
9133
|
-
"TEXT"
|
|
9134
|
-
],
|
|
9135
|
-
"type": "string",
|
|
9136
|
-
"fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
|
|
9137
|
-
},
|
|
9138
|
-
"key": {
|
|
9139
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
9140
|
-
"maxLength": 100,
|
|
9141
|
-
"type": "string",
|
|
9142
|
-
"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"
|
|
9143
|
-
}
|
|
9144
|
-
},
|
|
9145
|
-
"required": [
|
|
9146
|
-
"macroParameter",
|
|
9147
|
-
"type",
|
|
9148
|
-
"key"
|
|
9149
|
-
],
|
|
9150
|
-
"shortClassName": "textControlBean",
|
|
9151
|
-
"type": "object",
|
|
9152
|
-
"title": "TextControl",
|
|
9153
|
-
"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"
|
|
9154
|
-
},
|
|
9155
9123
|
{
|
|
9156
9124
|
"properties": {
|
|
9157
9125
|
"controls": {
|
|
9158
9126
|
"items": {
|
|
9159
9127
|
"properties": {
|
|
9128
|
+
"macroParameterValue": {
|
|
9129
|
+
"maxLength": 10000,
|
|
9130
|
+
"type": "string",
|
|
9131
|
+
"fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n"
|
|
9132
|
+
},
|
|
9160
9133
|
"label": {
|
|
9161
9134
|
"$ref": "#/definitions/i18nProperty",
|
|
9162
9135
|
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
9163
9136
|
},
|
|
9164
9137
|
"type": {
|
|
9165
9138
|
"enum": [
|
|
9166
|
-
"
|
|
9167
|
-
"
|
|
9139
|
+
"togglebutton",
|
|
9140
|
+
"TOGGLEBUTTON"
|
|
9168
9141
|
],
|
|
9169
9142
|
"type": "string",
|
|
9170
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
9143
|
+
"fieldDescription": "\n\nThe type field must be set to 'togglebutton'\n\n"
|
|
9171
9144
|
},
|
|
9172
9145
|
"key": {
|
|
9173
9146
|
"pattern": "^[a-zA-Z0-9-]+$",
|
|
@@ -9177,36 +9150,44 @@
|
|
|
9177
9150
|
}
|
|
9178
9151
|
},
|
|
9179
9152
|
"required": [
|
|
9153
|
+
"macroParameterValue",
|
|
9180
9154
|
"label",
|
|
9181
9155
|
"type",
|
|
9182
9156
|
"key"
|
|
9183
9157
|
],
|
|
9184
9158
|
"additionalProperties": true,
|
|
9185
|
-
"shortClassName": "
|
|
9159
|
+
"shortClassName": "macroToggleButtonControlBean",
|
|
9186
9160
|
"type": "object",
|
|
9187
|
-
"title": "
|
|
9188
|
-
"description": "\n\nDefines a button which
|
|
9161
|
+
"title": "ToggleButtonControl",
|
|
9162
|
+
"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"
|
|
9189
9163
|
},
|
|
9190
9164
|
"type": "array",
|
|
9191
|
-
"fieldDescription": "\n\
|
|
9165
|
+
"fieldDescription": "\n\nToggle buttons which will appear in the toggle group\n\n"
|
|
9166
|
+
},
|
|
9167
|
+
"macroParameter": {
|
|
9168
|
+
"pattern": "[-_a-z0-9\\.]+",
|
|
9169
|
+
"maxLength": 100,
|
|
9170
|
+
"type": "string",
|
|
9171
|
+
"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"
|
|
9192
9172
|
},
|
|
9193
9173
|
"type": {
|
|
9194
9174
|
"enum": [
|
|
9195
|
-
"
|
|
9196
|
-
"
|
|
9175
|
+
"togglegroup",
|
|
9176
|
+
"TOGGLEGROUP"
|
|
9197
9177
|
],
|
|
9198
9178
|
"type": "string",
|
|
9199
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
9179
|
+
"fieldDescription": "\n\nThe type field must be set to 'togglegroup'\n\n"
|
|
9200
9180
|
}
|
|
9201
9181
|
},
|
|
9202
9182
|
"required": [
|
|
9203
9183
|
"controls",
|
|
9184
|
+
"macroParameter",
|
|
9204
9185
|
"type"
|
|
9205
9186
|
],
|
|
9206
|
-
"shortClassName": "
|
|
9187
|
+
"shortClassName": "macroToggleGroupBean",
|
|
9207
9188
|
"type": "object",
|
|
9208
|
-
"title": "
|
|
9209
|
-
"description": "\n\nDefines a
|
|
9189
|
+
"title": "ToggleGroup",
|
|
9190
|
+
"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"
|
|
9210
9191
|
},
|
|
9211
9192
|
{
|
|
9212
9193
|
"properties": {
|
|
@@ -9245,22 +9226,17 @@
|
|
|
9245
9226
|
"controls": {
|
|
9246
9227
|
"items": {
|
|
9247
9228
|
"properties": {
|
|
9248
|
-
"macroParameterValue": {
|
|
9249
|
-
"maxLength": 10000,
|
|
9250
|
-
"type": "string",
|
|
9251
|
-
"fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n"
|
|
9252
|
-
},
|
|
9253
9229
|
"label": {
|
|
9254
9230
|
"$ref": "#/definitions/i18nProperty",
|
|
9255
9231
|
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
9256
9232
|
},
|
|
9257
9233
|
"type": {
|
|
9258
9234
|
"enum": [
|
|
9259
|
-
"
|
|
9260
|
-
"
|
|
9235
|
+
"button",
|
|
9236
|
+
"BUTTON"
|
|
9261
9237
|
],
|
|
9262
9238
|
"type": "string",
|
|
9263
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
9239
|
+
"fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
|
|
9264
9240
|
},
|
|
9265
9241
|
"key": {
|
|
9266
9242
|
"pattern": "^[a-zA-Z0-9-]+$",
|
|
@@ -9270,44 +9246,68 @@
|
|
|
9270
9246
|
}
|
|
9271
9247
|
},
|
|
9272
9248
|
"required": [
|
|
9273
|
-
"macroParameterValue",
|
|
9274
9249
|
"label",
|
|
9275
9250
|
"type",
|
|
9276
9251
|
"key"
|
|
9277
9252
|
],
|
|
9278
9253
|
"additionalProperties": true,
|
|
9279
|
-
"shortClassName": "
|
|
9254
|
+
"shortClassName": "buttonControlBean",
|
|
9280
9255
|
"type": "object",
|
|
9281
|
-
"title": "
|
|
9282
|
-
"description": "\n\nDefines a
|
|
9256
|
+
"title": "ButtonControl",
|
|
9257
|
+
"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"
|
|
9283
9258
|
},
|
|
9284
9259
|
"type": "array",
|
|
9285
|
-
"fieldDescription": "\n\
|
|
9260
|
+
"fieldDescription": "\n\nControls which will appear in the control group\n\n"
|
|
9286
9261
|
},
|
|
9262
|
+
"type": {
|
|
9263
|
+
"enum": [
|
|
9264
|
+
"group",
|
|
9265
|
+
"GROUP"
|
|
9266
|
+
],
|
|
9267
|
+
"type": "string",
|
|
9268
|
+
"fieldDescription": "\n\nThe type field must be set to 'group'\n\n"
|
|
9269
|
+
}
|
|
9270
|
+
},
|
|
9271
|
+
"required": [
|
|
9272
|
+
"controls",
|
|
9273
|
+
"type"
|
|
9274
|
+
],
|
|
9275
|
+
"shortClassName": "controlGroupBean",
|
|
9276
|
+
"type": "object",
|
|
9277
|
+
"title": "ControlGroup",
|
|
9278
|
+
"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"
|
|
9279
|
+
},
|
|
9280
|
+
{
|
|
9281
|
+
"properties": {
|
|
9287
9282
|
"macroParameter": {
|
|
9288
|
-
"pattern": "[-_a-z0-9\\.]+",
|
|
9289
9283
|
"maxLength": 100,
|
|
9290
9284
|
"type": "string",
|
|
9291
|
-
"fieldDescription": "\n\nThe
|
|
9285
|
+
"fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
|
|
9292
9286
|
},
|
|
9293
9287
|
"type": {
|
|
9294
9288
|
"enum": [
|
|
9295
|
-
"
|
|
9296
|
-
"
|
|
9289
|
+
"text",
|
|
9290
|
+
"TEXT"
|
|
9297
9291
|
],
|
|
9298
9292
|
"type": "string",
|
|
9299
|
-
"fieldDescription": "\n\nThe type field must be set to '
|
|
9293
|
+
"fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
|
|
9294
|
+
},
|
|
9295
|
+
"key": {
|
|
9296
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
9297
|
+
"maxLength": 100,
|
|
9298
|
+
"type": "string",
|
|
9299
|
+
"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"
|
|
9300
9300
|
}
|
|
9301
9301
|
},
|
|
9302
9302
|
"required": [
|
|
9303
|
-
"controls",
|
|
9304
9303
|
"macroParameter",
|
|
9305
|
-
"type"
|
|
9304
|
+
"type",
|
|
9305
|
+
"key"
|
|
9306
9306
|
],
|
|
9307
|
-
"shortClassName": "
|
|
9307
|
+
"shortClassName": "textControlBean",
|
|
9308
9308
|
"type": "object",
|
|
9309
|
-
"title": "
|
|
9310
|
-
"description": "\n\nDefines a
|
|
9309
|
+
"title": "TextControl",
|
|
9310
|
+
"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"
|
|
9311
9311
|
}
|
|
9312
9312
|
]
|
|
9313
9313
|
},
|
|
@@ -9543,6 +9543,53 @@
|
|
|
9543
9543
|
"type": "object",
|
|
9544
9544
|
"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",
|
|
9545
9545
|
"anyOf": [
|
|
9546
|
+
{
|
|
9547
|
+
"properties": {
|
|
9548
|
+
"offsetX": {
|
|
9549
|
+
"maxLength": 10,
|
|
9550
|
+
"type": "string",
|
|
9551
|
+
"fieldDescription": "\n\nSets an offset distance of the inline-dialog from the trigger element along the x-axis in pixels\n\n"
|
|
9552
|
+
},
|
|
9553
|
+
"offsetY": {
|
|
9554
|
+
"maxLength": 10,
|
|
9555
|
+
"type": "string",
|
|
9556
|
+
"fieldDescription": "\n\nSets an offset distance of the inline-dialog from the trigger element along the y-axis in pixels\n\n"
|
|
9557
|
+
},
|
|
9558
|
+
"width": {
|
|
9559
|
+
"maxLength": 10,
|
|
9560
|
+
"type": "string",
|
|
9561
|
+
"fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
|
|
9562
|
+
},
|
|
9563
|
+
"onTop": {
|
|
9564
|
+
"type": "boolean",
|
|
9565
|
+
"fieldDescription": "\n\nDetermines if the dialog should be shown above the trigger or not. If this option is true but there is insufficient room above the trigger the inline-dialog will be flipped to display below it\n\n"
|
|
9566
|
+
},
|
|
9567
|
+
"showDelay": {
|
|
9568
|
+
"type": "integer",
|
|
9569
|
+
"fieldDescription": "\n\nDetermines how long in milliseconds after a show trigger is fired (such as a trigger click) until the dialog is shown\n\n"
|
|
9570
|
+
},
|
|
9571
|
+
"closeOthers": {
|
|
9572
|
+
"type": "boolean",
|
|
9573
|
+
"fieldDescription": "\n\nDetermines if all other dialogs on the screen are closed when this one is opened\n\n"
|
|
9574
|
+
},
|
|
9575
|
+
"persistent": {
|
|
9576
|
+
"type": "boolean",
|
|
9577
|
+
"fieldDescription": "\n\nThis option, ignores the 'closeOthers' option\n\n"
|
|
9578
|
+
},
|
|
9579
|
+
"onHover": {
|
|
9580
|
+
"type": "boolean",
|
|
9581
|
+
"fieldDescription": "\n\nDetermines whether the inline-Dialog will show on a mouseOver or mouseClick of the trigger\n\n"
|
|
9582
|
+
},
|
|
9583
|
+
"isRelativeToMouse": {
|
|
9584
|
+
"type": "boolean",
|
|
9585
|
+
"fieldDescription": "\n\nDetermines if the dialog should be shown relative to where the mouse is at the time of the event trigger (normally a click) if set to false the dialog will show aligned to the left of the trigger with the arrow showing at the center\n\n"
|
|
9586
|
+
}
|
|
9587
|
+
},
|
|
9588
|
+
"shortClassName": "inlineDialogOptions",
|
|
9589
|
+
"type": "object",
|
|
9590
|
+
"title": "Inline Dialog Options",
|
|
9591
|
+
"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"
|
|
9592
|
+
},
|
|
9546
9593
|
{
|
|
9547
9594
|
"properties": {
|
|
9548
9595
|
"key": {
|
|
@@ -9603,53 +9650,6 @@
|
|
|
9603
9650
|
"type": "object",
|
|
9604
9651
|
"title": "Dialog Options",
|
|
9605
9652
|
"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"
|
|
9606
|
-
},
|
|
9607
|
-
{
|
|
9608
|
-
"properties": {
|
|
9609
|
-
"offsetX": {
|
|
9610
|
-
"maxLength": 10,
|
|
9611
|
-
"type": "string",
|
|
9612
|
-
"fieldDescription": "\n\nSets an offset distance of the inline-dialog from the trigger element along the x-axis in pixels\n\n"
|
|
9613
|
-
},
|
|
9614
|
-
"offsetY": {
|
|
9615
|
-
"maxLength": 10,
|
|
9616
|
-
"type": "string",
|
|
9617
|
-
"fieldDescription": "\n\nSets an offset distance of the inline-dialog from the trigger element along the y-axis in pixels\n\n"
|
|
9618
|
-
},
|
|
9619
|
-
"width": {
|
|
9620
|
-
"maxLength": 10,
|
|
9621
|
-
"type": "string",
|
|
9622
|
-
"fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
|
|
9623
|
-
},
|
|
9624
|
-
"onTop": {
|
|
9625
|
-
"type": "boolean",
|
|
9626
|
-
"fieldDescription": "\n\nDetermines if the dialog should be shown above the trigger or not. If this option is true but there is insufficient room above the trigger the inline-dialog will be flipped to display below it\n\n"
|
|
9627
|
-
},
|
|
9628
|
-
"showDelay": {
|
|
9629
|
-
"type": "integer",
|
|
9630
|
-
"fieldDescription": "\n\nDetermines how long in milliseconds after a show trigger is fired (such as a trigger click) until the dialog is shown\n\n"
|
|
9631
|
-
},
|
|
9632
|
-
"closeOthers": {
|
|
9633
|
-
"type": "boolean",
|
|
9634
|
-
"fieldDescription": "\n\nDetermines if all other dialogs on the screen are closed when this one is opened\n\n"
|
|
9635
|
-
},
|
|
9636
|
-
"persistent": {
|
|
9637
|
-
"type": "boolean",
|
|
9638
|
-
"fieldDescription": "\n\nThis option, ignores the 'closeOthers' option\n\n"
|
|
9639
|
-
},
|
|
9640
|
-
"onHover": {
|
|
9641
|
-
"type": "boolean",
|
|
9642
|
-
"fieldDescription": "\n\nDetermines whether the inline-Dialog will show on a mouseOver or mouseClick of the trigger\n\n"
|
|
9643
|
-
},
|
|
9644
|
-
"isRelativeToMouse": {
|
|
9645
|
-
"type": "boolean",
|
|
9646
|
-
"fieldDescription": "\n\nDetermines if the dialog should be shown relative to where the mouse is at the time of the event trigger (normally a click) if set to false the dialog will show aligned to the left of the trigger with the arrow showing at the center\n\n"
|
|
9647
|
-
}
|
|
9648
|
-
},
|
|
9649
|
-
"shortClassName": "inlineDialogOptions",
|
|
9650
|
-
"type": "object",
|
|
9651
|
-
"title": "Inline Dialog Options",
|
|
9652
|
-
"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"
|
|
9653
9653
|
}
|
|
9654
9654
|
]
|
|
9655
9655
|
},
|
|
@@ -10233,7 +10233,6 @@
|
|
|
10233
10233
|
"required": [
|
|
10234
10234
|
"authorization",
|
|
10235
10235
|
"exchange",
|
|
10236
|
-
"revokeToken",
|
|
10237
10236
|
"retrieveProfile"
|
|
10238
10237
|
],
|
|
10239
10238
|
"additionalProperties": false,
|