The identifier field
\n The identifier field refers to the name attribute of the var element in a blueprint\n template. If the identifier is matched with a template variable, the value is used in the substitution.\n If a template contains a variable, but there is no matching identifier in the context, an error is generated.\n An identifier with no matching template variable is regarded as a no-op.\n\n The identifier field for each context object must be unique. It is an error to have more than one context object with\n the same identifier, and it is undefined which will get picked during substitution.\n\n\n Some identifier names are reserved for use with special meaning during substitution. They\n must have a representation field with the value plain. The list below describes the meaning\n of each existing reserved identifier.\n\n - \n
- \n
ContentPageTitle: allows the blueprint template to set the page title. It must not contain any\n characters that cannot be used as a Confluence page title. If this reservedidentifieris not\n found in the context, the page created from the blueprint will not have a title set and\n will require the user to set it before it can be saved. The blueprint module must also specify\n 'edit' as the value of thecreateResultfield in this case. Note: the capital 'C'\n in the name is not a mistake or typo.\n \n - \n
labelsString: A space separated list of labels. The labels will be added to the page being created\n by this blueprint. See \n the Confluence docs about labels for more information.\n \n
identifiers.\n\n The representation field
\n\n The representation field must be one of the following values. If unset, it will default to plain.\n - \n
plain\n wiki\n storage\n
The value field
\n\n The value field must be in the same format as the representation field.\n If the format is incorrect (such as mismatched tags in storage format), an error message will be displayed\n in the resulting page. Here's an explanation of what each format means:\n\n - \n
- \n
plain: Plain text, which is HTML escaped during variable substitution. Use this for simple textual substitution.\n \n - \n
wiki: Valid \n Confluence Wiki Markup. The wiki markup will be rendered into html during substitution into the page.\n The resulting page will not contain any wiki markup. Use this format when simple styling\n is required (such as emphasis, underlines or and tables etc).\n \n - \n
storage: Valid \n Confluence Storage Format. This value is substituted into the page directly, before the page is rendered. Use this format\n to insert Confluence macros dynamically as part of your blueprint. See Macros\n for a list of available Confluence macros, including storage format examples.\n \n
Example of the request POST body
\n The context url may need some information to produce a more individually suitable response. Confluence\n will send some information related to the blueprint in the body of the request during the creation process.\n Here's an example of what will be sent in the body of the POST request:\n\n\n\n\n\n {\n \"addonKey\": \"addon-key\",\n \"blueprintKey\": \"blueprint-key\",\n \"spaceKey\": \"SPACEKEY\",\n \"userKey\": \"edd16ba6-0d41-4313-8bb9-84dc82cf6e7c\",\n \"userLocale\": \"fr_FR\"\n }\n\n\n\n- \n
addonKey: the key of the add-on that the blueprint is part of. \n blueprintKey: the key of the blueprint that triggered this context request. \n spaceKey: the space to create the page in (this is selected by the user in the Create dialog). \n userKey: the user key of the user creating the page from blueprint. \n userLocale: the locale of the user creating the page from blueprint. \n
url field in this module descriptor. See Properties for the definition of each field in the context.\n\n Substituting dynamic variables in a blueprint
\n\n Let's say we have a blueprint template module/blueprints/blueprint.xml:\n <h2 id="static1">Hello Blueprint</h2>\n<h2 id="custom1"><at:var at:name="ContentPageTitle"/></h2>\n<h2 id="custom2"><at:var at:name="custom-key1"/></h2>\n<h2 id="custom3"><at:var at:rawxhtml="true" at:name="custom-key2"/></h2>\n/blueprints/context which returns this JSON response as the context:\n\n\n\n\n\n [\n {\n \"identifier\": \"ContentPageTitle\",\n \"value\": \"Unique Page Title 1\",\n \"representation\": \"plain\"\n },\n {\n \"identifier\": \"custom-key1\",\n \"value\": \"custom value 1\",\n \"representation\": \"plain\"\n },\n {\n \"identifier\": \"custom-key2\",\n \"value\": \"/blueprints/context to retrieve\n the context. The context retrieved is parsed as a JSON array of objects and used in the substitute of\n the variables in the blueprint template above (custom-key1, custom-key2 are the variables).\n\n The final, variable substituted, storage format will look like this:\n <h2>Hello Blueprint</h2>\n<h2>Unique Page Title 1</h2>\n<h2>custom value 1</h2>\n<h2><ac:structured-macro ac:name="cheese" ac:schema-version="1" /></h2>\ncreateResult field of the blueprint module (see Blueprint Template Module).\n\n An error message appears in the Content Create Dialog if Confluence has any problems accessing the blueprint\n template or context URL (for example if your add-on server failed to respond in 10 seconds or the JSON\n returned is invalid). A detailed error and/or stacktrace may be accessible by Atlassian support, but the end user will see an\n error like the one shown here:\n ![\"Blueprint](\"/cloud/connect/images/confluence-blueprint-context-error.png\")
\n\n Backwards compatibility of the identifier field
\n A blueprint template containing variables may change as the add-on evolves over time. However, because end users\n can customize blueprint templates, it's possible for the customized version of the template to differ from\n the version in the add-on. This difference won't cause an error as long as the variables used in the template are\n still being returned as part of the context url.\n\n Add-ons wanting to retain backwards compatibility for their blueprint templates should ensure that any variables\n used in a template are always returned in the context url, even if a new version of the blueprint template no\n longer uses it (for example if users are relying on an old or customized version of the template). This ensures that the template\n continues to function when the add-on updates the template.\n\n",
"fieldDescription": "\n\nDefines the add-on server endpoint that provides the JSON objects used for substituting variables in the blueprint template.\n\n\n For more information on defining variables in blueprint templates, check out the examples in\n Blueprint Template Context.\n\n"
},
"url": {
"format": "uri",
"type": "string",
"fieldDescription": "\n\nThe URL of the add-on resource that provides the blueprint template content. This URL has to be relative\n to the add-on base URL.\n\n"
}
},
"required": [
"url"
],
"shortClassName": "blueprintTemplateBean",
"type": "object",
"title": "Blueprint Template",
"description": "\n\nDefines where the blueprint template is located and the context for variable substitution.\n\n\n\n\n\n {\n \"template\": {\n \"url\": \"/blueprints/blueprint.xml\",\n \"blueprintContext\": {\n \"url\": \"/blueprints/context\"\n }\n }\n }\n\n\n",
"fieldDescription": "\n\nDefines where the blueprint template is located and the context for variable substitution.\n For more about how to define variables in blueprint template and template context please follow the example in\n Blueprint Template Context.\n\n" }, "icon": { "$ref": "#/definitions/icon", "fieldDescription": "\n\nDefines an icon for this Blueprint, to be shown in the Create Content dialog.\n\n" }, "name": { "$ref": "#/definitions/i18nProperty", "fieldDescription": "\n\nA human readable name.\n\n" }, "description": { "$ref": "#/definitions/i18nProperty", "fieldDescription": "\n\nDefines a short description for this Blueprint, to be shown in the Create Content dialog.\n\n" }, "createResult": { "enum": [ "edit", "EDIT", "view", "VIEW" ], "type": "string", "fieldDescription": "\n\nDefines the screen to go to when creating this type of Blueprint. A value of `view` causes Confluence to bypass the\n editor page and automatically create the page content. The user lands in the view of the created page. When `edit`,\n the user is sent to the editor which is pre-filled with the template content.\n\n", "defaultValue": "edit" }, "key": { "$ref": "#/definitions/ModuleKeySchema" } }, "required": [ "key" ], "not": { "required": [ "unlicensedAccess" ] } }, "minItems": 1 }, "connect-confluence:spaceToolsTabs": { "type": "array", "items": { "properties": { "name": { "$ref": "#/definitions/i18nProperty", "fieldDescription": "\n\nA human readable name.\n\n" }, "weight": { "type": "integer", "fieldDescription": "\n\nDetermines the order in which the page's link appears in the menu or list.\n\n The \"lightest\" weight (i.e., lowest number) appears first, rising relative to other items,\n while the \"heaviest\" weights sink to the bottom of the menu or list.\n\n Built-in web items have weights that are incremented by numbers that leave room for additional\n items, such as by 10 or 100. Be mindful of the weight you choose for your item, so that it appears\n in a sensible order given existing items.\n\n", "defaultValue": "100" }, "location": { "maxLength": 100, "type": "string", "fieldDescription": "\n\nThe sub-section where this Space Tools Tab should appear. The primary section for Space Tabs is\n `system.space.tools`, and the location specified here will be beneath that. e.g setting a location of\n \"contenttools\" will result in a final location of `system.space.tools/contenttools`.\n\nConfluence comes the following standard sections in Space Tools:\n\n * system.space.tools/overview\n * system.space.tools/permissions\n * system.space.tools/contenttools\n * system.space.tools/lookandfeel\n * system.space.tools/integrations\n * system.space.tools/addons\n\nIn future, Connect add-ons will be able to define new web sections, which will enable add-ons to define new\n sub-sections for Space Tools.\n\nLegacy Space Admin section cannot be defined, and is always system.space.admin/spaceops\n\n" }, "conditions": { "items": { "type": "object", "anyOf": [ { "properties": { "conditions": { "items": { "type": "object", "anyOf": [ { "$ref": "#" }, { "$ref": "#/definitions/singleCondition" } ] }, "type": "array", "fieldDescription": "\n\nThe conditions to compose using the specific logical operator.\n\n" }, "type": { "enum": [ "and", "AND", "or", "OR" ], "type": "string", "fieldDescription": "\n\nDefines what logical operator is used to evaluate its collection of condition elements.\n\n" } }, "shortClassName": "compositeConditionBean", "type": "object", "title": "Composite Condition", "description": "\n\nComposite Conditions are composed of a collection of [Single Condition](../single-condition/) / Composite Conditions\n and a type attribute.\n\n
Example
\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" }, { "properties": { "condition": { "maxLength": 100, "type": "string", "fieldDescription": "\n\nA string indicating the name of the condition\n\n" }, "invert": { "type": "boolean", "fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n", "defaultValue": "false" }, "params": { "additionalProperties": true, "type": "object", "fieldTitle": "Object", "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\nExample
\n\n\n\n\n\n {\n \"params\": {\n \"someOtherProperty\": \"someValue\",\n \"myCustomProperty\": \"myValue\"\n }\n }\n\n\n" } }, "required": [ "condition" ], "shortClassName": "singleConditionBean", "type": "object", "title": "Single Condition", "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\nExample
\n\n\n\n\n\n {\n \"condition\": \"user_is_logged_in\",\n \"invert\": false\n }\n\n\n" } ] }, "type": "array", "fieldDescription": "\n\nConditions can be added to display only when all the given conditions are true.\n\n" }, "params": { "additionalProperties": true, "type": "object", "fieldTitle": "Object", "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\nExample
\n\n\n\n\n\n {\n \"params\": {\n \"someOtherProperty\": \"someValue\",\n \"myCustomProperty\": \"myValue\"\n }\n }\n\n\n" }, "url": { "format": "uri", "type": "string", "fieldDescription": "\n\nThe url to retrieve the content from.\n This can be absolute or relative to the add-on's baseUrl\n\n" }, "key": { "$ref": "#/definitions/ModuleKeySchema" } }, "required": [ "key" ], "not": { "required": [ "unlicensedAccess" ] } }, "minItems": 1 }, "connect-confluence:confluenceContentProperties": { "type": "array", "items": { "properties": { "name": { "$ref": "#/definitions/i18nProperty", "fieldDescription": "\n\nA human readable name.\n\n" }, "keyConfigurations": { "items": { "properties": { "propertyKey": { "maxLength": 100, "type": "string", "fieldDescription": "\n\nThe key of the property from which the data is indexed. Only alphanumeric characters are allowed,\n and it must be globally unique. Prefixing it with the name of your add-on is the best way to ensure this.\n\n" }, "extractions": { "items": { "properties": { "uiSupport": { "$ref": "#/definitions/uiSupport", "fieldDescription": "\n\nuiSupport can be used to define how your aliased field will be displayed in the CQL query builder.\n By defining uiSupport, your content property will appear in the CQL query builder for all macros and search\n features built on CQL. For example, your property will become usable in the\n Content By Label macro, and\n filterable by users on the Confluence search screen.\n\n Note: You need to define an alias to use uiSupport.\n\n"
},
"objectName": {
"maxLength": 1000,
"type": "string",
"fieldDescription": "\n\nThe objectName of the JSON data which should be indexed. The objectName is the key of a flattened JSON object with '.' as the path separator.\n\n For instance, for JSON \"{\"label\": {\"color\": \"red\", \"text\":\"connect\"}} the valid objectName\n referencing the color is label.color.\n\n Currently, specifying indexes for JSON arrays is not supported.\n\n"
},
"alias": {
"type": "string",
"fieldDescription": "\n\nA CQL field name alias for this content property.\n\n By defining an alias you are exposing it to CQL and allow other macros and search features to easily use\n your content property in their search.\n\n Important: Aliases must be globally unique. Prefixing it with the name of your add-on is the best way to ensure this.\n\n"
},
"type": {
"enum": [
"number",
"NUMBER",
"string",
"STRING",
"text",
"TEXT",
"date",
"DATE"
],
"type": "string",
"fieldDescription": "\n\nThe type of the referenced value.\n\n The type can be one of the following values:\n\n * number - The extracted number will be indexed as a double value for efficient range filtering and sorting.\n * text - The extracted value will be tokenized before indexing, allowing searching for particular words.\n * string - The entire extracted value will be indexed as a single token, without any filtering. When the extraction\n expression evaluates to a JSON array, each element will be indexed separately. This Enables searching for an exact value, e.g. a unique identifier.\n * date - Two representations are possible: either a string following the ISO 8601 datetime format,\n or a long value in Unix time. This enables efficient range filtering and sorting.\n\n"
}
},
"required": [
"objectName",
"type"
],
"shortClassName": "contentPropertyIndexExtractionConfigurationBean",
"type": "object",
"title": "Content Property Index Extraction Configuration",
"description": "\n\nAn extraction recipe for a single value within a content property JSON object.\n\n An extraction recipe defines which values within your JSON content property will be added to the search\n index and made available to CQL queries as a field. This can allow you to track custom information\n and make it look like a simple field on the content object.\n\n You can further extend the field definition by including\n UI support.\n\n See the content property key documentation for\n a complete example.\n\n Example
\n\n\n\n\n\n {\n \"objectName\": \"attachment.type\",\n \"type\": \"string\",\n \"alias\": \"contentType\",\n \"uiSupport\": {\n \"defaultOperator\": \"~\",\n \"name\": {\n \"value\": \"Content Type\",\n \"i18n\": \"attachment.type.name\"\n },\n \"tooltip\": {\n \"value\": \"Content Type Tooltip\",\n \"i18n\": \"attachment.type.tooltip\"\n },\n \"dataUri\": \"/data/content-types\",\n \"valueType\": \"string\"\n }\n }\n\n\n" }, "type": "array", "fieldDescription": "\n\nThe list with references to values of JSON objects which will be indexed and the types of referenced values.\n\n" } }, "required": [ "propertyKey", "extractions" ], "shortClassName": "contentPropertyIndexKeyConfigurationBean", "type": "object", "title": "Content Property Index Key Configuration", "description": "\n\nA Content Property Index Key Configuration defines which values from your JSON content property\n object should be indexed by Confluence and made available to the CQL search syntax.\n\n Each content property key will define one or more\n extractions which will\n allow for multiple values from your JSON content property to be used in CQL. Each extraction defines a single field\n that will be queryable using the relevant CQL syntax as seen below.\n\n In the wordcount example, we store details of the page\n that describe the word and character counts.\n\n After storing this JSON object as a content property:\n\n\n {\n \"wordCount\": 5\n \"characterCount\": 22\n }\n \n {\n \"propertyKey\": \"wordcount_addon\",\n \"extractions\": [\n { \"objectName\": \"wordCount\", \"type\": \"number\" },\n { \"objectName\": \"characterCount\", \"type\": \"number\" }\n ]\n }\n \n space = currentSpace() and content.property[wordcount_addon].wordCount <= 1000\n \n content.property[propertyKey].objectName\n \n {\n \"propertyKey\": \"wordcount_addon\",\n \"extractions\": [\n { \"objectName\": \"wordCount\", \"type\": \"number\", alias: \"wordcount\" }\n ]\n }\n \n space = currentSpace() and wordcount <= 1000\n alias must also be globally unique. Prefixing it with the name of your\n add-on is the best way to ensure this.\n\n Example
\n\n\n\n\n\n {\n \"propertyKey\": \"attachment\",\n \"extractions\": [\n {\n \"objectName\": \"attachment.size\",\n \"type\": \"number\"\n },\n {\n \"objectName\": \"attachment.type\",\n \"type\": \"string\",\n \"alias\": \"contentType\",\n \"uiSupport\": {\n \"defaultOperator\": \"~\",\n \"name\": {\n \"value\": \"Content Type\",\n \"i18n\": \"attachment.type.name\"\n },\n \"tooltip\": {\n \"value\": \"Content Type Tooltip\",\n \"i18n\": \"attachment.type.tooltip\"\n },\n \"dataUri\": \"/data/content-types\",\n \"valueType\": \"string\"\n }\n },\n {\n \"objectName\": \"attachment.updated\",\n \"type\": \"date\"\n }\n ]\n }\n\n\n" }, "type": "array", "fieldDescription": "\n\nA Content Property Index Key Configuration defines which values from your JSON content property\n object should be indexed and made available to the CQL search syntax.\n\n" }, "key": { "$ref": "#/definitions/ModuleKeySchema" } }, "required": [ "key" ], "not": { "required": [ "unlicensedAccess" ] } }, "minItems": 1 }, "connect-confluence:customContent": { "type": "array", "items": { "properties": { "uiSupport": { "$ref": "#/definitions/customContentUISupport", "fieldDescription": "\n\nDeclares information for rendering the custom content in the UI.\n\n" }, "name": { "$ref": "#/definitions/i18nProperty", "fieldDescription": "\n\nA human readable name.\n\n" }, "description": { "$ref": "#/definitions/i18nProperty", "fieldDescription": "\n\nThe description of the custom content\n\n" }, "apiSupport": { "$ref": "#/definitions/apiSupport", "fieldDescription": "\n\nThis property allows you to specify the container types your custom content can appear in, and its supported child content types.\n It also allows you to enable indexing of your custom content.\n\n" }, "key": { "$ref": "#/definitions/ModuleKeySchema" } }, "required": [ "key" ], "not": { "required": [ "unlicensedAccess" ] } }, "minItems": 1 }, "connect-confluence:dynamicContentMacros": { "type": "array", "items": { "properties": { "bodyType": { "enum": [ "rich-text", "RICH-TEXT", "plain-text", "PLAIN-TEXT", "none", "NONE" ], "type": "string", "fieldDescription": "\n\nThe type of body content, if any, for this macro.\n\n", "defaultValue": "none" }, "editor": { "properties": { "insertTitle": { "$ref": "#/definitions/i18nProperty", "fieldDescription": "\n\nAn optional title that will be shown in the edit dialog header for a new macro.\n\n" }, "editTitle": { "$ref": "#/definitions/i18nProperty", "fieldDescription": "\n\nAn optional title that will be shown in the edit dialog header for an existing macro.\n\n" }, "width": { "maxLength": 10, "type": "string", "fieldDescription": "\n\nThe preferred width of the edit dialog, e.g. ``500px``.\n\n" }, "cacheable": { "type": "boolean", "fieldDescription": "\n\nReturns whether the URL should be cacheable. Cacheable URLs are taken directly from the add-on descriptor, and\n lack all additional query parameters:\n- \n
- standard iframe query parameters \n
- product context parameters \n
- JWT token \n
Example
\n\n\n\n\n\n {\n \"editor\": {\n \"url\": \"/map-editor\",\n \"editTitle\": {\n \"value\": \"Edit Map\"\n },\n \"insertTitle\": {\n \"value\": \"Insert Map\"\n }\n }\n }\n\n\n", "fieldDescription": "\n\nThe configuration of a custom macro editor. This is useful if the parameter input field types are\n not sufficient to configure the macro.\n\n" }, "featured": { "type": "boolean", "fieldDescription": "\n\nWhether the macro should be \"featured\", meaning having an additional link in the \"Insert More Content\" menu in the editor toolbar.\n\n", "defaultValue": "false" }, "aliases": { "items": { "maxLength": 100, "type": "string" }, "type": "array", "fieldDescription": "\n\nDefine aliases for the macro. The macro browser will open for the defined aliases as if it were this macro.\n\n" }, "hidden": { "type": "boolean", "fieldDescription": "\n\nIf set to true, the macro will not appear in the macro browser.\n\n", "defaultValue": "false" }, "renderModes": { "properties": { "default": { "$ref": "#/definitions/embeddedStaticContentMacroBean", "fieldDescription": "\n\nThis render mode will be used for any static render mode that is not mapped directly. This is a catch\n all mode which allows you to set a default static fallback for all render modes.\n\n\n\n\n\n {\n \"default\": {\n \"url\": \"/render-map-default\"\n }\n }\n\n\n" }, "pdf": { "$ref": "#/definitions/embeddedStaticContentMacroBean", "fieldDescription": "\n\nThis render mode will be used when your macro is being rendered during \"export to pdf\".\n\n\n\n\n\n {\n \"pdf\": {\n \"url\": \"/render-map-pdf\"\n }\n }\n\n\n" }, "word": { "$ref": "#/definitions/embeddedStaticContentMacroBean", "fieldDescription": "\n\nThis render mode will be used when your macro is being rendered during \"export to word\".\n\n\n\n\n\n {\n \"word\": {\n \"url\": \"/render-map-word\"\n }\n }\n\n\n" }, "email": { "$ref": "#/definitions/embeddedStaticContentMacroBean", "fieldDescription": "\n\nThis render mode will be used when your macro is being rendered during email rendering, and requesting the EXPORT_VIEW representation.\n\n\n\n\n\n {\n \"email\": {\n \"url\": \"/render-map-email\"\n }\n }\n\n\n" } }, "shortClassName": "macroRenderModesBean", "type": "object", "title": "Macro Render Modes", "description": "\n\nAllows your dynamic content macro to provide different static macro implementations for different render modes.\n\n Dynamic Content Macros can include style sheets and javascript, allowing the development of rich interactive\n applications. When your macro is rendered in a web browser this can provide a modern, interactive web experience.\n\n When your macro is rendered to static formats such as PDF, or word, these interactive modes are\n often undesirable, or technically impossible.\n\n Macro Render Modes allow you to map a render mode to a static content macro. This allows you to\n provide an implementation of your macro for these formats, that will render safely to static formats.\n\nExample
\n\n\n\n\n\n {\n \"modules\": {\n \"dynamicContentMacros\": [\n {\n \"renderModes\": {\n \"pdf\": {\n \"url\": \"/render-map-pdf\"\n },\n \"default\": {\n \"url\": \"/render-map-static\"\n }\n },\n \"url\": \"/render-map?pageTitle={page.title}\",\n \"categories\": [],\n \"outputType\": \"block\",\n \"bodyType\": \"none\",\n \"aliases\": [],\n \"name\": {\n \"value\": \"Maps\"\n },\n \"key\": \"dynamic-macro-example\"\n }\n ]\n }\n }\n\n\n", "fieldDescription": "\n\nSince Dynamic Content Macros are rendered in an iframe, you are able to include your own style sheets and javascript.\n When your macro is exported to a static format such as PDF or Word, you can use the `renderModes` property to\n define a mapping between a certain type of output device and a static macro implementation. This will allow you\n to create a static view of your macro's data where an interactive model is not appropriate.\n\n" }, "documentation": { "$ref": "#/definitions/link", "fieldDescription": "\n\nA link to the documentation for the macro.\n\n" }, "icon": { "$ref": "#/definitions/icon", "fieldDescription": "\n\nA link to the icon resource (80x80 pixels) that will be shown in the macro selection dialog.\n The URL can be absolute or relative to the add-on base URL.\n\n" }, "description": { "$ref": "#/definitions/i18nProperty", "fieldDescription": "\n\nA description of the macro's functionality.\n\n" }, "outputType": { "enum": [ "block", "BLOCK", "inline", "INLINE" ], "type": "string", "fieldDescription": "\n\nHow this macro should be placed along side other page content.\n\n", "defaultValue": "block" }, "url": { "format": "uri", "type": "string", "fieldDescription": "\n\nThe link to the add-on resource that provides the macro content.\n This URL has to be relative to the add-on base URL.\n\n Additional context parameters can be passed as variables in the URL:\n\n {\n \"url\": \"/macro-renderer?body={macro.body}&space_id={space.id}&page_id={page.id}\"\n }\n \n {\n \"url\": \"/render-macro?pageId={page.id}&pageVersion={page.version}¯oId={macro.id}\"\n }\n \n AP.require(\"request\", function(request) {\n var pageId = getUrlParameter(\"pageId\");\n var pageVersion = getUrlParameter(\"pageVersion\");\n var macroId = getUrlParameter(\"macroId\");\n request({\n url: \"/rest/api/content/\" + pageId +\n \"/history/\" + pageVersion +\n \"/macro/id/\" + macroId,\n success: function(response) {\n var macro = JSON.parse(response);\n process(macro.body);\n }\n });\n });\n Example
\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" }, { "properties": { "controls": { "items": { "properties": { "macroParameterValue": { "maxLength": 10000, "type": "string", "fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n" }, "label": { "$ref": "#/definitions/i18nProperty", "fieldDescription": "\n\nText which will appear inside the button\n\n" }, "type": { "enum": [ "togglebutton", "TOGGLEBUTTON" ], "type": "string", "fieldDescription": "\n\nThe type field must be set to 'togglebutton'\n\n" }, "key": { "pattern": "^[a-zA-Z0-9-]+$", "maxLength": 100, "type": "string", "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n" } }, "required": [ "macroParameterValue", "label", "type", "key" ], "additionalProperties": true, "shortClassName": "macroToggleButtonControlBean", "type": "object", "title": "ToggleButtonControl", "description": "\n\nDefines a toggle button which appears inside a ToggleGroup\n\nExample
\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" }, "type": "array", "fieldDescription": "\n\nToggle buttons which will appear in the toggle group\n\n" }, "macroParameter": { "pattern": "[-_a-z0-9\\.]+", "maxLength": 100, "type": "string", "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" }, "type": { "enum": [ "togglegroup", "TOGGLEGROUP" ], "type": "string", "fieldDescription": "\n\nThe type field must be set to 'togglegroup'\n\n" } }, "required": [ "controls", "macroParameter", "type" ], "shortClassName": "macroToggleGroupBean", "type": "object", "title": "ToggleGroup", "description": "\n\nDefines a ToggleGroup which may appear in control extension points such as the property panel\n\nExample
\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" }, { "properties": { "controls": { "items": { "properties": { "label": { "$ref": "#/definitions/i18nProperty", "fieldDescription": "\n\nText which will appear inside the button\n\n" }, "type": { "enum": [ "button", "BUTTON" ], "type": "string", "fieldDescription": "\n\nThe type field must be set to 'button'\n\n" }, "key": { "pattern": "^[a-zA-Z0-9-]+$", "maxLength": 100, "type": "string", "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n" } }, "required": [ "label", "type", "key" ], "additionalProperties": true, "shortClassName": "buttonControlBean", "type": "object", "title": "ButtonControl", "description": "\n\nDefines a button which may appear in control extension points such as the property panel\n\nExample
\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" }, "type": "array", "fieldDescription": "\n\nControls which will appear in the control group\n\n" }, "type": { "enum": [ "group", "GROUP" ], "type": "string", "fieldDescription": "\n\nThe type field must be set to 'group'\n\n" } }, "required": [ "controls", "type" ], "shortClassName": "controlGroupBean", "type": "object", "title": "ControlGroup", "description": "\n\nDefines a ControlGroup which may appear in control extension points such as the property panel\n\nExample
\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" }, { "properties": { "macroParameter": { "maxLength": 100, "type": "string", "fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n" }, "type": { "enum": [ "text", "TEXT" ], "type": "string", "fieldDescription": "\n\nThe type field must be set to 'text'\n\n" }, "key": { "pattern": "^[a-zA-Z0-9-]+$", "maxLength": 100, "type": "string", "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" } }, "required": [ "macroParameter", "type", "key" ], "shortClassName": "textControlBean", "type": "object", "title": "TextControl", "description": "\n\nDefines a text field which may appear in control extension points such as the property panel\n\nExample
\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" } ] }, "type": "array", "fieldDescription": "\n\nList of controls which will be added to the macro property panel\n\n" }, "cacheable": { "type": "boolean", "fieldDescription": "\n\nReturns whether the URL should be cacheable. Cacheable URLs are taken directly from the add-on descriptor, and\n lack all additional query parameters:\n- \n
- standard iframe query parameters \n
- product context parameters \n
- JWT token \n
This is useful to chain multiple macros with each other. For example a macro can provide adf table data\n which can be used to produce a chart with it.
\n\n", "fieldDescription": "\n\n" }, "width": { "maxLength": 10, "type": "string", "fieldDescription": "\n\nThe preferred width of the macro content.\n\n" }, "name": { "$ref": "#/definitions/i18nProperty", "fieldDescription": "\n\nA human readable name.\n\n" }, "cacheable": { "type": "boolean", "fieldDescription": "\n\nReturns whether the URL should be cacheable. Cacheable URLs are taken directly from the add-on descriptor, and\n lack all additional query parameters:\n- \n
- standard iframe query parameters \n
- product context parameters \n
- JWT token \n
\n\"dynamicContentMacros\": [{\n ...\n \"url\": \"/render-map?pageTitle={page.title}&viewChoice={view}\",\n ...\n}]\n Example
\n\n\n\n\n\n {\n \"dynamicContentMacros\": {\n \"renderModes\": {},\n \"url\": \"/my-macro\",\n \"categories\": [],\n \"outputType\": \"block\",\n \"bodyType\": \"none\",\n \"aliases\": [],\n \"parameters\": [\n {\n \"identifier\": \"view\",\n \"name\": {\n \"value\": \"Map View\"\n },\n \"description\": {\n \"value\": \"Allows switching between view types\"\n },\n \"type\": \"enum\",\n \"required\": true,\n \"multiple\": false,\n \"defaultValue\": \"Map\",\n \"values\": [\n \"Map\",\n \"Satellite\"\n ],\n \"hidden\": false,\n \"indexing\": {\n \"enabled\": true\n }\n }\n ],\n \"name\": {\n \"value\": \"My macro with placeholder\"\n },\n \"key\": \"my-macro-key\"\n }\n }\n\n\n" }, "type": "array", "fieldDescription": "\n\nThe list of parameter input fields that will be displayed.\n\n" }, "height": { "maxLength": 10, "type": "string", "fieldDescription": "\n\nThe preferred height of the macro content, e.g. ``10px``,``100%``.\n\n" }, "key": { "$ref": "#/definitions/ModuleKeySchema" } }, "required": [ "key" ], "not": { "required": [ "unlicensedAccess" ] } }, "minItems": 1 }, "connect-confluence:staticContentMacros": { "type": "array", "items": { "properties": { "bodyType": { "enum": [ "rich-text", "RICH-TEXT", "plain-text", "PLAIN-TEXT", "none", "NONE" ], "type": "string", "fieldDescription": "\n\nThe type of body content, if any, for this macro.\n\n", "defaultValue": "none" }, "editor": { "properties": { "insertTitle": { "$ref": "#/definitions/i18nProperty", "fieldDescription": "\n\nAn optional title that will be shown in the edit dialog header for a new macro.\n\n" }, "editTitle": { "$ref": "#/definitions/i18nProperty", "fieldDescription": "\n\nAn optional title that will be shown in the edit dialog header for an existing macro.\n\n" }, "width": { "maxLength": 10, "type": "string", "fieldDescription": "\n\nThe preferred width of the edit dialog, e.g. ``500px``.\n\n" }, "cacheable": { "type": "boolean", "fieldDescription": "\n\nReturns whether the URL should be cacheable. Cacheable URLs are taken directly from the add-on descriptor, and\n lack all additional query parameters:\n- \n
- standard iframe query parameters \n
- product context parameters \n
- JWT token \n
Example
\n\n\n\n\n\n {\n \"editor\": {\n \"url\": \"/map-editor\",\n \"editTitle\": {\n \"value\": \"Edit Map\"\n },\n \"insertTitle\": {\n \"value\": \"Insert Map\"\n }\n }\n }\n\n\n", "fieldDescription": "\n\nThe configuration of a custom macro editor. This is useful if the parameter input field types are\n not sufficient to configure the macro.\n\n" }, "featured": { "type": "boolean", "fieldDescription": "\n\nWhether the macro should be \"featured\", meaning having an additional link in the \"Insert More Content\" menu in the editor toolbar.\n\n", "defaultValue": "false" }, "aliases": { "items": { "maxLength": 100, "type": "string" }, "type": "array", "fieldDescription": "\n\nDefine aliases for the macro. The macro browser will open for the defined aliases as if it were this macro.\n\n" }, "hidden": { "type": "boolean", "fieldDescription": "\n\nIf set to true, the macro will not appear in the macro browser.\n\n", "defaultValue": "false" }, "documentation": { "$ref": "#/definitions/link", "fieldDescription": "\n\nA link to the documentation for the macro.\n\n" }, "icon": { "$ref": "#/definitions/icon", "fieldDescription": "\n\nA link to the icon resource (80x80 pixels) that will be shown in the macro selection dialog.\n The URL can be absolute or relative to the add-on base URL.\n\n" }, "description": { "$ref": "#/definitions/i18nProperty", "fieldDescription": "\n\nA description of the macro's functionality.\n\n" }, "outputType": { "enum": [ "block", "BLOCK", "inline", "INLINE" ], "type": "string", "fieldDescription": "\n\nHow this macro should be placed along side other page content.\n\n", "defaultValue": "block" }, "url": { "format": "uri", "type": "string", "fieldDescription": "\n\nThe link to the add-on resource that provides the macro content.\n This URL has to be relative to the add-on base URL.\n\n Additional context parameters can be passed as variables in the URL:\n\n {\n \"url\": \"/macro-renderer?body={macro.body}&space_id={space.id}&page_id={page.id}\"\n }\n \n {\n \"url\": \"/render-macro?pageId={page.id}&pageVersion={page.version}¯oId={macro.id}\"\n }\n \n AP.require(\"request\", function(request) {\n var pageId = getUrlParameter(\"pageId\");\n var pageVersion = getUrlParameter(\"pageVersion\");\n var macroId = getUrlParameter(\"macroId\");\n request({\n url: \"/rest/api/content/\" + pageId +\n \"/history/\" + pageVersion +\n \"/macro/id/\" + macroId,\n success: function(response) {\n var macro = JSON.parse(response);\n process(macro.body);\n }\n });\n });\n Example
\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" }, "type": "array", "fieldDescription": "\n\nToggle buttons which will appear in the toggle group\n\n" }, "macroParameter": { "pattern": "[-_a-z0-9\\.]+", "maxLength": 100, "type": "string", "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" }, "type": { "enum": [ "togglegroup", "TOGGLEGROUP" ], "type": "string", "fieldDescription": "\n\nThe type field must be set to 'togglegroup'\n\n" } }, "required": [ "controls", "macroParameter", "type" ], "shortClassName": "macroToggleGroupBean", "type": "object", "title": "ToggleGroup", "description": "\n\nDefines a ToggleGroup which may appear in control extension points such as the property panel\n\nExample
\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" }, { "properties": { "label": { "$ref": "#/definitions/i18nProperty", "fieldDescription": "\n\nText which will appear inside the button\n\n" }, "type": { "enum": [ "button", "BUTTON" ], "type": "string", "fieldDescription": "\n\nThe type field must be set to 'button'\n\n" }, "key": { "pattern": "^[a-zA-Z0-9-]+$", "maxLength": 100, "type": "string", "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n" } }, "required": [ "label", "type", "key" ], "additionalProperties": true, "shortClassName": "buttonControlBean", "type": "object", "title": "ButtonControl", "description": "\n\nDefines a button which may appear in control extension points such as the property panel\n\nExample
\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" }, { "properties": { "macroParameter": { "maxLength": 100, "type": "string", "fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n" }, "type": { "enum": [ "text", "TEXT" ], "type": "string", "fieldDescription": "\n\nThe type field must be set to 'text'\n\n" }, "key": { "pattern": "^[a-zA-Z0-9-]+$", "maxLength": 100, "type": "string", "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" } }, "required": [ "macroParameter", "type", "key" ], "shortClassName": "textControlBean", "type": "object", "title": "TextControl", "description": "\n\nDefines a text field which may appear in control extension points such as the property panel\n\nExample
\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" }, { "properties": { "controls": { "items": { "properties": { "label": { "$ref": "#/definitions/i18nProperty", "fieldDescription": "\n\nText which will appear inside the button\n\n" }, "type": { "enum": [ "button", "BUTTON" ], "type": "string", "fieldDescription": "\n\nThe type field must be set to 'button'\n\n" }, "key": { "pattern": "^[a-zA-Z0-9-]+$", "maxLength": 100, "type": "string", "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n" } }, "required": [ "label", "type", "key" ], "additionalProperties": true, "shortClassName": "buttonControlBean", "type": "object", "title": "ButtonControl", "description": "\n\nDefines a button which may appear in control extension points such as the property panel\n\nExample
\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" }, "type": "array", "fieldDescription": "\n\nControls which will appear in the control group\n\n" }, "type": { "enum": [ "group", "GROUP" ], "type": "string", "fieldDescription": "\n\nThe type field must be set to 'group'\n\n" } }, "required": [ "controls", "type" ], "shortClassName": "controlGroupBean", "type": "object", "title": "ControlGroup", "description": "\n\nDefines a ControlGroup which may appear in control extension points such as the property panel\n\nExample
\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" } ] }, "type": "array", "fieldDescription": "\n\nList of controls which will be added to the macro property panel\n\n" }, "cacheable": { "type": "boolean", "fieldDescription": "\n\nReturns whether the URL should be cacheable. Cacheable URLs are taken directly from the add-on descriptor, and\n lack all additional query parameters:\n- \n
- standard iframe query parameters \n
- product context parameters \n
- JWT token \n
\n If the rendering method was set to POST like this:\n
\n {\n \"renderingMethod\": \"POST\",\n \"url\": \"/macro-renderer?body={macro.body}\"\n }\n /macro-renderer like:\n
\n POST /macro-renderer HTTP/1.1\n Authorization: JWT <JWT token>\n Content-Type: application/x-www-form-urlencoded\n Transfer-Encoding: chunked\n Host: <host>\n User-Agent: Atlassian HttpClient <atlassian http client version> / Confluence-<confluence version> / Atlassian-Connect/<connect version>\n\n body=<macro body>&<some value>&pageVersion=<some value>&tz=<some value>&lic=<some value>&user_key=<some value>&xd&_e=<some value>&cp=<some value>&xdm_c=<some value>&cv=<some value>&user_id=<some value>\n application/x-www-form-urlencoded instead of URL query parameters.\n The latest version of
Atlassian Connect Express and Atlassian Connect Spring Boot\n have built-in support for verifying requests sent by POST. However you might need to implement the query hash\n verification if the framework you are using doesn't support it.\n\n",
"defaultValue": "get"
},
"name": {
"$ref": "#/definitions/i18nProperty",
"fieldDescription": "\n\nA human readable name.\n\n"
},
"categories": {
"items": {
"maxLength": 100,
"type": "string"
},
"type": "array",
"fieldDescription": "\n\nThe categories the macro should appear in. A macro with no category will show up in the default 'All' category.\n\n Currently, the following categories are supported by Confluence:\n\n * `admin`: Administration\n * `communication`: Communication\n * `confluence-content`: Confluence Content\n * `development`: Development\n * `external-content`: External Content\n * `formatting`: Formatting\n * `media`: Media\n * `navigation`: Navigation\n * `reporting`: Reporting\n * `visuals`: Visuals & Images\n\n"
},
"parameters": {
"items": {
"properties": {
"identifier": {
"pattern": "[-_a-z0-9\\.]+",
"type": "string",
"fieldDescription": "\n\nA unique identifier for the parameter.\n It must only contain lowercase alphanumeric characters, dashes, underscores, dots and must not contain any spaces.\n This identifier will be used in the query parameters of the add-on URL.\n\n"
},
"aliases": {
"items": {
"maxLength": 100,
"type": "string"
},
"type": "array",
"fieldDescription": "\n\nAliases for the macro parameter.\n\n"
},
"hidden": {
"type": "boolean",
"fieldDescription": "\n\nDetermines if the parameter will be displayed in the macro editor.\n\n",
"defaultValue": "false"
},
"indexing": {
"$ref": "#/definitions/indexing",
"fieldDescription": "\n\nDefines how this macro parameter will be indexed\n\n"
},
"defaultValue": {
"maxLength": 1000,
"type": "string",
"fieldDescription": "\n\nThe default value for the parameter.\n\n"
},
"values": {
"items": {
"maxLength": 1000,
"type": "string"
},
"type": "array",
"fieldDescription": "\n\nDescribes the ``enum`` values - only applicable for enum typed parameters.\n\n"
},
"name": {
"$ref": "#/definitions/i18nProperty",
"fieldDescription": "\n\nThe human readable name of the parameter which will be displayed in the UI.\n\n"
},
"multiple": {
"type": "boolean",
"fieldDescription": "\n\nWhether it takes multiple values.\n\n",
"defaultValue": "false"
},
"description": {
"$ref": "#/definitions/i18nProperty",
"fieldDescription": "\n\nThe description of the parameter\n\n"
},
"type": {
"enum": [
"attachment",
"ATTACHMENT",
"boolean",
"BOOLEAN",
"confluence-content",
"CONFLUENCE-CONTENT",
"enum",
"ENUM",
"int",
"INT",
"label",
"LABEL",
"spacekey",
"SPACEKEY",
"string",
"STRING",
"url",
"URL",
"username",
"USERNAME"
],
"type": "string",
"fieldDescription": "\n\nThe type of parameter.\n\n Currently the following parameter types are supported in the macro browser's UI:\n\n * `attachment`: displays an autocomplete field for search on attachment filenames.\n * `boolean`: displays a check box.\n * `confluence-content`: displays an autocomplete field for search on page and blog titles.\n * `enum`: displays a select field.\n * `spacekey`: displays an autocomplete field for search on space names.\n * `string`: displays an input field (this is the default if unknown type).\n * `username`: displays an autocomplete field for search on username and full name currently, and will be overridden by Atlassian AccountId after GDPR deprecation period ends. During the deprecation only, a companion parameter with \".accountId\" suffix of the original parameter name will be added.\n\n"
},
"required": {
"type": "boolean",
"fieldDescription": "\n\nWhether it is a required parameter.\n\n",
"defaultValue": "false"
}
},
"required": [
"identifier",
"name",
"type"
],
"shortClassName": "macroParameterBean",
"type": "object",
"title": "Macro Input Parameter",
"description": "\n\nDescribes a parameter input field for a macro.\n\n Any declared parameters must also be included in the URL value of the macro in order to serialise this value, for\n example, for a macro with a parameter `view` it should be added to the macro url as follows:\n\n \n\"dynamicContentMacros\": [{\n ...\n \"url\": \"/render-map?pageTitle={page.title}&viewChoice={view}\",\n ...\n}]\n Example
\n\n\n\n\n\n {\n \"dynamicContentMacros\": {\n \"renderModes\": {},\n \"url\": \"/my-macro\",\n \"categories\": [],\n \"outputType\": \"block\",\n \"bodyType\": \"none\",\n \"aliases\": [],\n \"parameters\": [\n {\n \"identifier\": \"view\",\n \"name\": {\n \"value\": \"Map View\"\n },\n \"description\": {\n \"value\": \"Allows switching between view types\"\n },\n \"type\": \"enum\",\n \"required\": true,\n \"multiple\": false,\n \"defaultValue\": \"Map\",\n \"values\": [\n \"Map\",\n \"Satellite\"\n ],\n \"hidden\": false,\n \"indexing\": {\n \"enabled\": true\n }\n }\n ],\n \"name\": {\n \"value\": \"My macro with placeholder\"\n },\n \"key\": \"my-macro-key\"\n }\n }\n\n\n" }, "type": "array", "fieldDescription": "\n\nThe list of parameter input fields that will be displayed.\n\n" }, "key": { "$ref": "#/definitions/ModuleKeySchema" } }, "required": [ "key" ], "not": { "required": [ "unlicensedAccess" ] } }, "minItems": 1 }, "connect-confluence:contentBylineItems": { "type": "array", "items": { "properties": { "context": { "enum": [ "page", "PAGE", "addon", "ADDON", "product", "PRODUCT" ], "type": "string", "fieldDescription": "\n\nThe context for the URL parameter. Not applicable if an absolute URL is specified. Possible values\n- \n
addon
- a URL relative to the add-on's base URL \n page
- targets a Page module by specifying the Page's module key as the URL \n product
- a URL relative to the product's base URL \n
- \n
- standard iframe query parameters \n
- product context parameters \n
- JWT token \n
Example
\n\n\n\n\n\n {\n \"params\": {\n \"someOtherProperty\": \"someValue\",\n \"myCustomProperty\": \"myValue\"\n }\n }\n\n\n" }, "contentPropertyKey": { "pattern": "^[a-zA-Z0-9-]+$", "maxLength": 100, "type": "string", "fieldDescription": "\n\n\n An optional Content Property key\n that this Byline Item will be bound to.\n
\n\n\n The key must only contain alphanumeric characters and dashes.\n
\n\n\n When a key is supplied, the:\n
\n \n\n for this Byline item will be overwritten with the property's corresponding value (if present), and the rendered item\n will be updated as the value changes in the browser.\n
\n\n This requires the stored Content Property to have the following format:
\n\n\n\n\n\n {\n \"name\": {\n \"value\": \"Item Text\"\n },\n \"icon\": {\n \"width\": 16,\n \"height\": 16,\n \"url\": \"/my-icon.png\"\n },\n \"tooltip\": {\n \"value\": \"Item Tooltip\"\n }\n }\n\n\n\n
\n Note that only fields present in the original bean will be respected when substituting values from a\n Content Property later. This means that to show a Content-Property-based tooltip, this Content\n Byline Item module must specify a tooltip. Likewise for a Content-Property-based\n icon, this module must specify an icon.\n
contextfield.\n\n
\n This field is required if the target of the item is not a\n Dialog Module.\n
An object containing options which vary based on the type of web item target you are implementing.
\n\nCurrently-allowed options are:
\n- \n
- Inline Dialog Options when type is \"inlinedialog\", and \n
- Dialog Options when type is \"dialog\" \n
- Dialog Module Options when type is \"dialogmodule\" \n
Example
\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" }, { "properties": { "key": { "maxLength": 100, "type": "string", "fieldDescription": "\n\nThe key of a Dialog module declared in this Connect add-on.
\n\n\n The dialog module will include the Dialog Options\n that would otherwise need to be specified directly in this options object.\n
\n\n" } }, "required": [ "key" ], "shortClassName": "dialogModuleOptions", "type": "object", "title": "Dialog Module Options", "description": "\n\nOptions for a web-item targeting a common dialog module.\n\nExample
\n\n\n\n\n\n {\n \"target\": {\n \"type\": \"dialogmodule\",\n \"options\": {\n \"key\": \"dialog-module-key\"\n }\n }\n }\n\n\n" }, { "properties": { "size": { "enum": [ "small", "SMALL", "medium", "MEDIUM", "large", "LARGE", "x-large", "X-LARGE", "fullscreen", "FULLSCREEN", "maximum", "MAXIMUM" ], "type": "string", "fieldDescription": "\n\nSets the size of the dialog.\n\n\n This option is used instead of the 'height' and 'width' options.\n
\n\n" }, "chrome": { "type": "boolean", "fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n", "defaultValue": "true" }, "width": { "maxLength": 10, "type": "string", "fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n" }, "header": { "$ref": "#/definitions/i18nProperty", "fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n" }, "height": { "maxLength": 10, "type": "string", "fieldDescription": "\n\nSets how high the dialog is in pixels\n\n" } }, "shortClassName": "dialogOptions", "type": "object", "title": "Dialog Options", "description": "\n\nOptions for a modal dialog web item target or common module.\n\n\n These options are a subset of those available via the JavaScript API.\n
\n\nWeb Item Example
\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\nDialog Example
\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" } ] }, "type": { "enum": [ "page", "PAGE", "dialog", "DIALOG", "inlinedialog", "INLINEDIALOG", "dialogmodule", "DIALOGMODULE" ], "type": "string", "fieldDescription": "\n\nDefines how the web-item content should be loaded by the page. By default, the web-item is loaded in the same\n page. The target can be set to open the web-item url as a modal dialog or an inline dialog.\n\n", "defaultValue": "page" } }, "shortClassName": "webItemTargetBean", "type": "object", "title": "Web Item Target", "description": "\n\nDefines the way a web item link is opened in the browser, such as in a modal or inline dialog.\n\nInline Dialog Example
\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\n\nDialog Example
\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\nCommon Dialog Module Example
\n\n\n\n\n\n {\n \"target\": {\n \"type\": \"dialogmodule\",\n \"options\": {\n \"key\": \"dialog-module-key\"\n }\n }\n }\n\n\n\n\nMore details for this use-case can be found on the Dialog Module page.
\n\n", "fieldDescription": "\n\nDefines the behaviour when the item is triggered.\n If omitted, the url behaves as a regular hyperlink.\n\n" }, "key": { "$ref": "#/definitions/ModuleKeySchema" } }, "required": [ "key" ], "not": { "required": [ "unlicensedAccess" ] } }, "minItems": 1 }, "connect-confluence:confluenceThemes": { "type": "array", "items": { "properties": { "routes": { "properties": { "spaceview": { "properties": { "url": { "format": "uri", "type": "string", "fieldDescription": "\n\nA url for displaying a given view. This url can be interpolated with a set of variables. See\n Theme Routes for a list of\n context parameters available.\n\n" } }, "required": [ "url" ], "shortClassName": "confluenceThemeRouteBean", "type": "object", "title": "Theme Route Definition", "description": "\n\nDefines the data required for each individual route.\n\n Theurl field is a URL that is to be used as an iframe for the full page iframe rendered for the route.\n\n",
"fieldDescription": "\n\nRoute for the space homepage - the screen when a user views a space. Overriding\n this route will allow the add-on to customize what the user sees when they visit a space homepage.\n Available context parameters in the url are\n - \n
space.key- the space key of the content being viewed \n
url field of each individual route definition\n will be provided with context parameters for the particular route. For example, the spaceview route\n can have as a URL /my-spaceview/{space.key},\n and the context parameter space.key is going to be replaced with the actual space key of the content being viewed.\n\n The context parameters username and userkey will be removed after GDPR deprecation period ends.\n\n Below is a list of all possible routes, and the context parameters associated with the route.\n\n",
"fieldDescription": "\n\nDefines what routes to override for this Theme.\n See Theme Routes for a description of each route,\n as well as the appropriate context parameters available for each route.\n\n"
},
"lookAndFeel": {
"$ref": "#/definitions/lookAndFeel",
"fieldDescription": "\n\nThe look and feel for the Theme\n\n"
},
"icon": {
"$ref": "#/definitions/icon",
"fieldDescription": "\n\nAn icon to display in the Theme selector in the Confluence administration screen. The icon will be resized to\n 110px wide and 70px high to fit inside the Theme selector.\n\n"
},
"routeOverride": {
"type": "boolean",
"fieldDescription": "\n\nA configuration to enable or disable route override. The default is true.\n\n"
},
"name": {
"$ref": "#/definitions/i18nProperty",
"fieldDescription": "\n\nA human readable name.\n\n"
},
"description": {
"$ref": "#/definitions/i18nProperty",
"fieldDescription": "\n\nA description for the Theme. This will appear next to the icon in the Theme selector in the Confluence admininstration screen.\n\n"
},
"availableGlobally": {
"type": "boolean",
"fieldDescription": "\n\nA configuration to make the theme available to select in global administration. The default is false.\n\n"
},
"key": {
"$ref": "#/definitions/ModuleKeySchema"
}
},
"required": [
"key"
],
"not": {
"required": [
"unlicensedAccess"
]
}
},
"minItems": 1
},
"connect-confluence:lifecycle": {
"type": "array",
"items": {
"properties": {
"installed": {
"format": "uri",
"type": "string",
"fieldDescription": "\n\nWhen a Connect add-on is installed, a synchronous request is fired to this URL to initiate the installation\n handshake. In order to successfully complete installation, the add-on must respond with either a\n 200 OK or 204 No Content status.\n\n\n\n"
},
"disabled": {
"format": "uri",
"type": "string",
"fieldDescription": "\n\nFires when an add on has been successfully disabled. This is an asynchronous notification event.\n\n"
},
"dare-migration": {
"type": "string",
"fieldDescription": "\n\nUsed DaRe app migration service to trigger migrations events\n\n"
},
"uninstalled": {
"format": "uri",
"type": "string",
"fieldDescription": "\n\nFires when an add on has been successfully un-installed. This is an asynchronous notification event.\n\n"
},
"enabled": {
"format": "uri",
"type": "string",
"fieldDescription": "\n\nFires when an add on has been successfully enabled. This is an asynchronous notification event.\n\n"
},
"key": {
"$ref": "#/definitions/ModuleKeySchema"
}
},
"required": [
"key"
],
"not": {
"required": [
"unlicensedAccess"
]
}
},
"minItems": 1
},
"automation:action": {
"type": "array",
"items": {
"type": "object",
"properties": {
"function": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9-_]+$"
},
"config": {
"type": "object",
"properties": {
"function": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9-_]+$"
}
}
},
"key": {
"$ref": "#/definitions/ModuleKeySchema"
}
},
"required": [
"function",
"config",
"key"
],
"not": {
"required": [
"unlicensedAccess"
]
}
},
"minItems": 1
},
"automation:trigger": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"function": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9-_]+$"
},
"key": {
"$ref": "#/definitions/ModuleKeySchema"
}
},
"required": [
"title",
"function",
"key"
],
"additionalProperties": true,
"not": {
"required": [
"unlicensedAccess"
]
}
},
"minItems": 1
},
"automation:condition": {
"type": "array",
"items": {
"type": "object",
"properties": {
"function": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9-_]+$"
},
"config": {
"type": "object",
"properties": {
"function": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9-_]+$"
}
}
},
"key": {
"$ref": "#/definitions/ModuleKeySchema"
}
},
"required": [
"function",
"config",
"key"
],
"additionalProperties": true,
"not": {
"required": [
"unlicensedAccess"
]
}
},
"minItems": 1
},
"automation:branch": {
"type": "array",
"items": {
"type": "object",
"properties": {
"function": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9-_]+$"
},
"config": {
"type": "object",
"properties": {
"function": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9-_]+$"
}
}
},
"key": {
"$ref": "#/definitions/ModuleKeySchema"
}
},
"required": [
"function",
"config",
"key"
],
"additionalProperties": true,
"not": {
"required": [
"unlicensedAccess"
]
}
},
"minItems": 1
},
"automation:attributeResolver": {
"type": "array",
"items": {
"type": "object",
"properties": {
"function": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9-_]+$"
},
"key": {
"$ref": "#/definitions/ModuleKeySchema"
}
},
"required": [
"function",
"key"
],
"additionalProperties": true,
"not": {
"required": [
"unlicensedAccess"
]
}
},
"minItems": 1
},
"automation:template": {
"type": "array",
"items": {
"type": "object",
"properties": {
"function": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9-_]+$"
},
"key": {
"$ref": "#/definitions/ModuleKeySchema"
}
},
"required": [
"function",
"key"
],
"additionalProperties": true,
"not": {
"required": [
"unlicensedAccess"
]
}
},
"minItems": 1
},
"automation:i18n": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resource": {
"type": "string"
},
"supportedLocales": {
"additionalProperties": {
"type": "string"
}
},
"key": {
"$ref": "#/definitions/ModuleKeySchema"
}
},
"required": [
"resource",
"supportedLocales",
"key"
],
"not": {
"required": [
"unlicensedAccess"
]
}
},
"minItems": 1
}
},
"title": "ModuleSchema",
"type": "object"
},
"BearerMethodSchema": {
"oneOf": [
{
"type": "string",
"enum": [
"authorization-header",
"form-encoded",
"uri-query"
]
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"authorization-header",
"form-encoded",
"uri-query"
]
},
"prefix": {
"type": "string",
"description": "Custom authorization header prefix",
"maxLength": 1000
},
"parameter": {
"type": "string",
"description": "Custom Header name or Parameter name (depending on type)",
"maxlength": 1000
}
}
}
]
},
"ModuleKeySchema": {
"type": "string",
"title": "ModuleKeySchema",
"description": "A key for the module. Must be unique within the manifest.",
"pattern": "^[a-zA-Z0-9_-]+$"
},
"AppPermissionsSchema": {
"additionalProperties": false,
"type": "object",
"title": "AppPermissionsSchema",
"properties": {
"scopes": {
"items": {
"type": "string"
},
"title": "scopes",
"type": "array",
"minItems": 0
},
"content": {
"additionalProperties": false,
"type": "object",
"title": "content",
"properties": {
"scripts": {
"items": {
"maxLength": 128,
"type": "string"
},
"title": "scripts",
"type": "array",
"minItems": 0
},
"styles": {
"items": {
"enum": [
"unsafe-inline"
]
},
"title": "styles",
"type": "array",
"minItems": 0
}
}
},
"external": {
"additionalProperties": false,
"type": "object",
"title": "external",
"properties": {
"fetch": {
"additionalProperties": false,
"type": "object",
"title": "fetch",
"properties": {
"backend": {
"items": {
"oneOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "object",
"description": "References a Remote",
"title": "remote",
"properties": {
"remote": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"remote"
],
"additionalProperties": false
}
]
},
"title": "backend",
"type": "array",
"minItems": 0
},
"client": {
"items": {
"oneOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "object",
"description": "References a Remote",
"title": "remote",
"properties": {
"remote": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"remote"
],
"additionalProperties": false
}
]
},
"title": "client",
"type": "array",
"minItems": 0
}
}
},
"fonts": {
"items": {
"type": "string",
"maxLength": 1000
},
"title": "fonts",
"type": "array",
"minItems": 0
},
"frames": {
"items": {
"type": "string",
"maxLength": 1000
},
"title": "frames",
"type": "array",
"minItems": 0
},
"navigation": {
"items": {
"type": "string",
"maxLength": 1000
},
"title": "navigation",
"type": "array",
"minItems": 0
},
"images": {
"items": {
"type": "string",
"maxLength": 1000
},
"title": "images",
"type": "array",
"minItems": 0
},
"media": {
"items": {
"type": "string",
"maxLength": 1000
},
"title": "media",
"type": "array",
"minItems": 0
},
"scripts": {
"items": {
"type": "string",
"maxLength": 1000
},
"title": "scripts",
"type": "array",
"minItems": 0
},
"styles": {
"items": {
"type": "string",
"maxLength": 1000
},
"title": "styles",
"type": "array",
"minItems": 0
}
}
}
}
},
"HostedResourcesSchema": {
"type": "array",
"items": {
"type": "object",
"title": "HostedResourcesSchema",
"required": [
"key",
"path"
],
"additionalProperties": false,
"properties": {
"key": {
"type": "string",
"description": "A key for the resource, which other modules can refer to. Must be unique within the manifest and have a maximum of 23 characters.",
"pattern": "^[a-zA-Z0-9_-]+$",
"maxLength": 23
},
"path": {
"type": "string"
},
"tunnel": {
"type": "object",
"required": [
"port"
],
"properties": {
"port": {
"type": "number"
}
},
"additionalProperties": false
}
}
}
},
"RemotesSchema": {
"type": "array",
"items": {
"type": "object",
"title": "RemotesSchema",
"required": [
"key",
"baseUrl"
],
"additionalProperties": false,
"properties": {
"key": {
"type": "string",
"description": "A key for the remote, which other modules can refer to. Must be unique within the manifest and have a maximum of 23 characters.",
"pattern": "^[a-zA-Z0-9_-]+$",
"maxLength": 23
},
"baseUrl": {
"type": "string"
},
"operations": {
"description": "The type of operations done in the remote",
"type": "array",
"items": {
"type": "string",
"enum": [
"storage",
"other"
]
},
"minItems": 1
},
"storage": {
"description": "Options related to remote storage",
"type": "object",
"required": [
"classifications"
],
"additionalProperties": false,
"properties": {
"classifications": {
"description": "Labels to classify the type of data stored",
"type": "array",
"items": {
"type": "string",
"enum": [
"ugc",
"pii",
"other"
]
},
"minItems": 1
}
}
}
}
}
},
"ProvidersSchema": {
"type": "object",
"additionalProperties": false,
"required": [
"auth"
],
"properties": {
"auth": {
"type": "array",
"title": "auth",
"description": "External authentication providers",
"items": {
"oneOf": [
{
"$ref": "#/definitions/AuthProviderCustom",
"title": "AuthProviderCustom"
},
{
"$ref": "#/definitions/AuthProviderPredefined",
"title": "AuthProviderPredefined"
}
]
}
}
}
},
"AuthProviderPredefined": {
"type": "object",
"additionalProperties": false,
"required": [
"key",
"name",
"integration",
"bearerMethod",
"clientId",
"remotes"
],
"properties": {
"key": {
"$ref": "#/definitions/ModuleKeySchema"
},
"name": {
"type": "string",
"description": "Name shown to end users",
"maxLength": 1000
},
"integration": {
"type": "string",
"enum": [
"adobe",
"azuredevops",
"dropbox",
"google",
"miro"
],
"description": "Pre-defined integration name"
},
"bearerMethod": {
"$ref": "#/definitions/BearerMethodSchema"
},
"clientId": {
"type": "string",
"maxLength": 1000
},
"scopes": {
"type": "array",
"minItems": 0,
"items": {
"type": "string"
}
},
"remotes": {
"type": "array",
"items": {
"$ref": "#/definitions/ModuleKeySchema"
}
}
}
},
"AuthProviderCustom": {
"type": "object",
"additionalProperties": false,
"required": [
"key",
"type",
"name",
"bearerMethod",
"clientId",
"actions"
],
"properties": {
"key": {
"$ref": "#/definitions/ModuleKeySchema"
},
"name": {
"type": "string",
"description": "Name shown to end users",
"maxLength": 1000
},
"type": {
"type": "string",
"enum": [
"oauth2"
]
},
"bearerMethod": {
"$ref": "#/definitions/BearerMethodSchema"
},
"clientId": {
"type": "string",
"maxLength": 1000
},
"scopes": {
"type": "array",
"minItems": 0,
"items": {
"type": "string"
}
},
"remotes": {
"type": "array",
"items": {
"$ref": "#/definitions/ModuleKeySchema"
}
},
"actions": {
"type": "object",
"required": [
"authorization",
"exchange",
"retrieveProfile"
],
"additionalProperties": false,
"properties": {
"authorization": {
"$ref": "#/definitions/AuthorizeActionDefinition"
},
"exchange": {
"$ref": "#/definitions/ExchangeActionDefinition"
},
"revokeToken": {
"$ref": "#/definitions/ActionDefinition"
},
"retrieveProfile": {
"oneOf": [
{
"type": "object",
"title": "DynamicProfileRetriever",
"description": "Use a Forge function to map the fields to profile information",
"required": [
"remote",
"path",
"function"
],
"additionalProperties": false,
"properties": {
"remote": {
"$ref": "#/definitions/ModuleKeySchema"
},
"path": {
"type": "string",
"maxLength": 1000
},
"function": {
"$ref": "#/definitions/ModuleKeySchema"
}
}
},
{
"type": "object",
"title": "StaticProfileRetriever",
"description": "A static direct mapping of API response fields to profile information",
"required": [
"remote",
"path",
"resolvers"
],
"additionalProperties": false,
"properties": {
"remote": {
"$ref": "#/definitions/ModuleKeySchema"
},
"path": {
"type": "string",
"maxLength": 1000
},
"resolvers": {
"type": "object",
"required": [
"id",
"displayName"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"displayName": {
"type": "string"
},
"avatarUrl": {
"type": "string"
}
}
}
}
}
]
}
}
}
}
},
"AuthorizeActionDefinition": {
"type": "object",
"required": [
"remote",
"path"
],
"additionalProperties": false,
"properties": {
"remote": {
"$ref": "#/definitions/ModuleKeySchema"
},
"path": {
"type": "string",
"maxLength": 1000
},
"queryParameters": {
"type": "object",
"description": "Additional GET parameters sent to the API",
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9_-]+$": {
"type": "string"
}
}
}
}
},
"ExchangeActionDefinition": {
"type": "object",
"required": [
"remote",
"path"
],
"additionalProperties": false,
"properties": {
"remote": {
"$ref": "#/definitions/ModuleKeySchema"
},
"path": {
"type": "string",
"maxLength": 1000
},
"resolvers": {
"type": "object",
"additionalProperties": false,
"properties": {
"accessToken": {
"type": "string",
"description": "Path to the 'access token' parameter within the JSON response from the auhuorization API (full stop separated for nested parameters)",
"default": "access_token",
"maxLength": 1000
},
"accessTokenExpires": {
"type": "string",
"description": "Path to the 'access token expires' parameter within the JSON response from the auhuorization API (full stop separated for nested parameters)",
"default": "expires_in",
"maxLength": 1000
},
"refreshToken": {
"type": "string",
"description": "Path to the 'refresh token' parameter within the JSON response from the auhuorization API (full stop separated for nested parameters)",
"default": "refresh_token",
"maxlength": 1000
}
}
}
}
},
"ActionDefinition": {
"type": "object",
"required": [
"remote",
"path"
],
"additionalProperties": false,
"properties": {
"remote": {
"$ref": "#/definitions/ModuleKeySchema"
},
"path": {
"type": "string",
"maxLength": 1000
},
"queryParameters": {
"type": "object",
"description": "Additional GET parameters sent to the API",
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9_-]+$": {
"type": "string"
}
}
}
}
},
"Array": {
"items": {
"type": "string"
},
"title": "Array",
"type": "array"
},
"ExtensionKey": {
"description": "The key for an extension in CaaS. That means that this is a reference to another\nextension in your descriptor / manifest.\n\nThis key is defined in: https://bitbucket.org/atlassian/connect-service/src/cd7252b/service/cs-apps/api.raml#lines-1094",
"maxLength": 255,
"minLength": 1,
"pattern": "^[a-zA-Z0-9-._]+$",
"title": "ExtensionKey",
"type": "string"
},
"ProductEvents": {
"$ref": "#/definitions/Array",
"title": "ProductEvents",
"type": "array",
"items": {
"type": "string"
}
},
"ProductEventsFilter": {
"additionalProperties": false,
"title": "ProductEventsFilter",
"type": "object",
"properties": {
"ignoreSelf": {
"title": "ignoreSelf",
"description": "The app will ignore events generated by itself",
"type": "boolean"
}
},
"required": [
"ignoreSelf"
]
},
"FilteredProductEvents": {
"title": "FilteredProductEvents",
"type": "array",
"items": {
"type": "object",
"properties": {
"eventType": {
"title": "eventType",
"type": "string"
},
"filter": {
"$ref": "#/definitions/ProductEventsFilter",
"title": "filter",
"type": "object"
}
},
"required": [
"eventType",
"filter"
]
}
},
"DisplayConditions": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"customFieldName": {
"title": "customFieldName",
"type": "string"
},
"customFieldValue": {
"title": "customFieldValue",
"type": "string"
}
},
"required": [
"customFieldName",
"customFieldValue"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"componentTypes": {
"anyOf": [
{
"items": {
"enum": [
"APPLICATION",
"LIBRARY",
"OTHER",
"SERVICE"
],
"type": "string"
},
"type": "array"
},
{
"enum": [
"APPLICATION",
"LIBRARY",
"OTHER",
"SERVICE"
],
"type": "string"
}
],
"title": "componentTypes"
}
},
"required": [
"componentTypes"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"not": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"customFieldName": {
"title": "customFieldName",
"type": "string"
},
"customFieldValue": {
"title": "customFieldValue",
"type": "string"
}
},
"required": [
"customFieldName",
"customFieldValue"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"componentTypes": {
"anyOf": [
{
"items": {
"enum": [
"APPLICATION",
"LIBRARY",
"OTHER",
"SERVICE"
],
"type": "string"
},
"type": "array"
},
{
"enum": [
"APPLICATION",
"LIBRARY",
"OTHER",
"SERVICE"
],
"type": "string"
}
],
"title": "componentTypes"
}
},
"required": [
"componentTypes"
],
"type": "object"
}
],
"title": "not"
}
},
"required": [
"not"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"or": {
"items": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"customFieldName": {
"title": "customFieldName",
"type": "string"
},
"customFieldValue": {
"title": "customFieldValue",
"type": "string"
}
},
"required": [
"customFieldName",
"customFieldValue"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"componentTypes": {
"anyOf": [
{
"items": {
"enum": [
"APPLICATION",
"LIBRARY",
"OTHER",
"SERVICE"
],
"type": "string"
},
"type": "array"
},
{
"enum": [
"APPLICATION",
"LIBRARY",
"OTHER",
"SERVICE"
],
"type": "string"
}
],
"title": "componentTypes"
}
},
"required": [
"componentTypes"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"not": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"customFieldName": {
"title": "customFieldName",
"type": "string"
},
"customFieldValue": {
"title": "customFieldValue",
"type": "string"
}
},
"required": [
"customFieldName",
"customFieldValue"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"componentTypes": {
"anyOf": [
{
"items": {
"enum": [
"APPLICATION",
"LIBRARY",
"OTHER",
"SERVICE"
],
"type": "string"
},
"type": "array"
},
{
"enum": [
"APPLICATION",
"LIBRARY",
"OTHER",
"SERVICE"
],
"type": "string"
}
],
"title": "componentTypes"
}
},
"required": [
"componentTypes"
],
"type": "object"
}
],
"title": "not"
}
},
"required": [
"not"
],
"type": "object"
}
]
},
"title": "or",
"type": "array"
}
},
"required": [
"or"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"and": {
"items": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"customFieldName": {
"title": "customFieldName",
"type": "string"
},
"customFieldValue": {
"title": "customFieldValue",
"type": "string"
}
},
"required": [
"customFieldName",
"customFieldValue"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"componentTypes": {
"anyOf": [
{
"items": {
"enum": [
"APPLICATION",
"LIBRARY",
"OTHER",
"SERVICE"
],
"type": "string"
},
"type": "array"
},
{
"enum": [
"APPLICATION",
"LIBRARY",
"OTHER",
"SERVICE"
],
"type": "string"
}
],
"title": "componentTypes"
}
},
"required": [
"componentTypes"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"not": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"customFieldName": {
"title": "customFieldName",
"type": "string"
},
"customFieldValue": {
"title": "customFieldValue",
"type": "string"
}
},
"required": [
"customFieldName",
"customFieldValue"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"componentTypes": {
"anyOf": [
{
"items": {
"enum": [
"APPLICATION",
"LIBRARY",
"OTHER",
"SERVICE"
],
"type": "string"
},
"type": "array"
},
{
"enum": [
"APPLICATION",
"LIBRARY",
"OTHER",
"SERVICE"
],
"type": "string"
}
],
"title": "componentTypes"
}
},
"required": [
"componentTypes"
],
"type": "object"
}
],
"title": "not"
}
},
"required": [
"not"
],
"type": "object"
}
]
},
"title": "and",
"type": "array"
}
},
"required": [
"and"
],
"type": "object"
}
]
},
"i18nProperty": {
"properties": {
"value": {
"maxLength": 1500,
"type": "string",
"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"
},
"i18n": {
"maxLength": 300,
"type": "string",
"fieldDescription": "\n\nThe localization key for the human-readable value.\n Translations for the keys are defined at the top level of the\n add-on descriptor.\n\n"
}
},
"required": [
"value"
],
"shortClassName": "i18nProperty",
"type": "object",
"title": "i18n Property",
"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 Example
\n\n\n\n\n\n {\n \"value\": \"My text\"\n }\n\n\n" }, "icon": { "properties": { "width": { "type": "integer", "fieldDescription": "\n\nThe width in pixels of the icon image.\n\n" }, "url": { "format": "uri", "type": "string", "fieldDescription": "\n\nThe URL of the icon. Your icon needs to be hosted remotely at a web-accessible location. You can specify the\n URL as an absolute URL or relative to the add-on's base URL.\n\n" }, "height": { "type": "integer", "fieldDescription": "\n\nThe height in pixels of the icon image.\n\n" } }, "required": [ "url" ], "shortClassName": "iconBean", "type": "object", "title": "Icon", "description": "\n\nDefines an icon to display.\n\nExample
\n\n\n\n\n\n {\n \"icon\": {\n \"width\": 16,\n \"height\": 16,\n \"url\": \"/my-icon.png\"\n }\n }\n\n\n" }, "singleCondition": { "properties": { "condition": { "maxLength": 100, "type": "string", "fieldDescription": "\n\nA string indicating the name of the condition\n\n" }, "invert": { "type": "boolean", "fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n", "defaultValue": "false" }, "params": { "additionalProperties": true, "type": "object", "fieldTitle": "Object", "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\nExample
\n\n\n\n\n\n {\n \"params\": {\n \"someOtherProperty\": \"someValue\",\n \"myCustomProperty\": \"myValue\"\n }\n }\n\n\n" } }, "required": [ "condition" ], "shortClassName": "singleConditionBean", "type": "object", "title": "Single Condition", "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\nExample
\n\n\n\n\n\n {\n \"condition\": \"user_is_logged_in\",\n \"invert\": false\n }\n\n\n" }, "compositeCondition": { "properties": { "conditions": { "items": { "type": "object", "anyOf": [ { "$ref": "#" }, { "$ref": "#/definitions/singleCondition" } ] }, "type": "array", "fieldDescription": "\n\nThe conditions to compose using the specific logical operator.\n\n" }, "type": { "enum": [ "and", "AND", "or", "OR" ], "type": "string", "fieldDescription": "\n\nDefines what logical operator is used to evaluate its collection of condition elements.\n\n" } }, "shortClassName": "compositeConditionBean", "type": "object", "title": "Composite Condition", "description": "\n\nComposite Conditions are composed of a collection of [Single Condition](../single-condition/) / Composite Conditions\n and a type attribute.\n\nExample
\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" }, "webPanelLayout": { "properties": { "width": { "maxLength": 10, "type": "string", "fieldDescription": "\n\n" }, "height": { "maxLength": 10, "type": "string", "fieldDescription": "\n\n" } }, "shortClassName": "webPanelLayout", "type": "object", "title": "Web Panel Layout", "description": "\n\nExample
\n\n\n\n\n\n {\n \"layout\": {\n \"width\": \"100\",\n \"height\": \"200\"\n }\n }\n\n\n" }, "dialogOptions": { "properties": { "size": { "enum": [ "small", "SMALL", "medium", "MEDIUM", "large", "LARGE", "x-large", "X-LARGE", "fullscreen", "FULLSCREEN", "maximum", "MAXIMUM" ], "type": "string", "fieldDescription": "\n\nSets the size of the dialog.\n\n\n This option is used instead of the 'height' and 'width' options.\n
\n\n" }, "chrome": { "type": "boolean", "fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n", "defaultValue": "true" }, "width": { "maxLength": 10, "type": "string", "fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n" }, "header": { "$ref": "#/definitions/i18nProperty", "fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n" }, "height": { "maxLength": 10, "type": "string", "fieldDescription": "\n\nSets how high the dialog is in pixels\n\n" } }, "shortClassName": "dialogOptions", "type": "object", "title": "Dialog Options", "description": "\n\nOptions for a modal dialog web item target or common module.\n\n\n These options are a subset of those available via the JavaScript API.\n
\n\nWeb Item Example
\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\nDialog Example
\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" }, "featureFlagProviderActionsBean": { "properties": { "linkFlag": { "properties": { "templateUrl": { "type": "string", "fieldDescription": "\n\n" } }, "required": [ "templateUrl" ], "shortClassName": "featureFlagProviderActionBean", "type": "object", "description": "\n\nDefines the URL template that is used when an action is invoked. The following context parameters are supported: {issue.key}, {issue.summary}, {issue.flags}.
Defines the URL template that is used when an action is invoked. The following context parameters are supported: {issue.key}, {issue.summary}, {issue.flags}.
Defines the URL template that is used when an action is invoked. The following context parameters are supported: {issue.key}, {issue.summary}, {issue.flags}.
Feature flag actions that can be performed by Jira users.
\nEach action is optional (unless indicated otherwise). The absence of an action indicates that the action is not supported by the provider.
\n\n" }, "url": { "properties": { "url": { "format": "uri", "type": "string", "fieldDescription": "\n\n" } }, "required": [ "url" ], "shortClassName": "urlBean", "type": "object", "title": "URL", "description": "\n\n" }, "developmentToolModuleActionsBean": { "properties": { "createBranch": { "properties": { "templateUrl": { "type": "string", "fieldDescription": "\n\n" } }, "required": [ "templateUrl" ], "shortClassName": "developmentToolModuleActionBean", "type": "object", "description": "\n\nDefines the URL template that is used when an action is invoked. The following context parameters are supported: {issue.key}, {issue.summary}.
Development actions that can be performed by Jira users.
\nEach action is optional (unless indicated otherwise). The absence of an action indicates that the action is not supported by the provider.
\n\n" }, "uiSupport": { "properties": { "defaultOperator": { "maxLength": 100, "type": "string", "fieldDescription": "\n\nThe CQL builder will use this operator when constructing the CQL string.\n\n" }, "dataUri": { "type": "string", "fieldDescription": "\n\nIf provided, the CQL builder will provide a drop down and use this url to find the list of value values. This\n URL should return a json array of objects describing the valid options.\n\n\n [\n {\"id\": \"value1\", \"text\": \"First Option\"},\n {\"id\": \"value2\", \"text\": \"Second Option\"}\n ]\n Access-Control-Allow-Origin header to the URL of the Atlassian Cloud instance where\n this add-on is installed is usually enough to satisfy the CORS requirements. This can be done by tracking\n the client key and its url in your /installed callback, then looking up the url when the request\n is made.\n\n"
},
"valueType": {
"enum": [
"space",
"SPACE",
"label",
"LABEL",
"user",
"USER",
"contentid",
"CONTENTID",
"contenttype",
"CONTENTTYPE",
"date",
"DATE",
"string",
"STRING",
"number",
"NUMBER"
],
"type": "string",
"fieldDescription": "\n\nAs well as providing a text field and allowing any entry, the UI support system provides a number of\n build in components that can enrich the user experience. These provide extra user interface components\n to allow setting or picking their value in an intuitive way.\n\n The type can be one of the following values:\n\n - \n
space- provides a space picker and stores the result space key as the result. \n label- provides a label picker and stores the list of labels as the result. \n user- provides a user picker and stores the username as the result. \n contentId- provides a content picker and stores the content id as the result. \n contentType- provides a content type picker. \n date- provides a date picker \n string- provides a free form text field \n number- provides a free form text field \n
Example
\n\n\n\n\n\n {\n \"defaultOperator\": \"~\",\n \"name\": {\n \"value\": \"Content Type\",\n \"i18n\": \"attachment.type.name\"\n },\n \"tooltip\": {\n \"value\": \"Content Type Tooltip\",\n \"i18n\": \"attachment.type.tooltip\"\n },\n \"dataUri\": \"/data/content-types\",\n \"valueType\": \"string\"\n }\n\n\n" }, "customContentUISupport": { "properties": { "editComponentTitlePlaceholder": { "$ref": "#/definitions/i18nProperty", "fieldDescription": "\n\nDefines a placeholder for title input box that will be used in the edit component.\n Following variables will be replaced at runtime:\n- \n
{spaceName}: Name of the current space \n {spaceKey}: Key of the current space \n {contentTypeName}: Name of the current custom content \n
\n \"What do you want to know about {SpaceName}\" will become \"What do you want to know about Demonstration Space\"\n if user is creating a new piece of custom content in \"Demonstration Space\" space.\n\n" }, "listViewComponent": { "$ref": "#/definitions/componentReference", "fieldDescription": "\n\nDefines a module that will be used when user clicks the navigation link displayed in the space sidebar.
\n The module referenced must be a generalPage.\n A default list view will be provided if no view component was specified in this field.\n\n" }, "editComponent": { "$ref": "#/definitions/componentReference", "fieldDescription": "\n\nDefines a module for adding or editing custom content.
\n The module referenced must be a generalPage.\n Following context variable will be provided to the edit component URL\n
- \n
customcontent.create: Indicates whether user is creating or editing a piece of custom content \n
\n Please refer to the Custom Content JavaScript API\n for how to intercept the edit component events and override the default behavior.\n\n
![\"Custom](\"/cloud/connect/images/confluence-customcontent-edit.png\")
\n\n"
},
"icons": {
"properties": {
"item": {
"$ref": "#/definitions/icon",
"fieldDescription": "\n\nDefines an icon that used for displaying a single custom content item in:\n - \n
- View attachments screen when the custom content is contained in a page. \n
- Result entry of site search. \n
- Result entry of quick search. \n
\n\n" }, "create": { "$ref": "#/definitions/icon", "fieldDescription": "\n\nDefines an icon that is used for custom content items in the create dialog.
\n The icon resource provided in this field must be larger or equals to 48x48 pixels.
\n It will fallback to item icon if this field is not specified.\n In that case, please ensure the item icon is larger or equals to 48x48 pixels.\n\n" }, "list": { "$ref": "#/definitions/icon", "fieldDescription": "\n\nDefines an icon that used for displaying list of custom content items in:\n
- \n
- Space sidebar if this custom content is allowed to be contained in space. \n
\n It will fallback to item icon if this field is not specified.\n In that case, please ensure the item icon is larger or equals to 20x20 pixels.\n\n" } }, "required": [ "item" ], "shortClassName": "customContentIconsBean", "type": "object", "title": "Custom Content Icons", "description": "\n\nDefines icons that used for displaying the custom content.\n\n\n\n\n\n {\n \"item\": {\n \"width\": 16,\n \"height\": 16,\n \"url\": \"/item.png\"\n }\n }\n\n\n", "fieldDescription": "\n\nDefines icons used for displaying the content.\n\n" }, "contentViewComponent": { "$ref": "#/definitions/componentReference", "fieldDescription": "\n\nDefines a module for viewing custom content.
\n The module referenced must be a generalPage.\n\n The view component will get displayed in following places:\n
- \n
- \n Search result
\n When user clicks the title of a custom content entry in site search result.\n \n
\n Following sorting orders will apply:\n
- \n
- Relationships defined in different names: Sorted by the order defined in this field \n
- Relationships defined in the same name: Sorted by creation time of the relation \n
\n\n
Use Relation API to generate breadcrumbs
\n An add-on can specify multiple content relationships for generating the breadcrumbs.\n Suppose we haveac:add-on-key:employee defined with following breadcrumbs setting:\n \n ...\n \"breadcrumbs\": {\n \"relations\": [\n {\n \"name\": \"worksFor\"\n }\n ]\n }\n ...\n | Content ID | \nContent Type | \nTitle | \n
|---|---|---|
| 1 | \nac:add-on-key:organization | \nCompany A | \n
| 2 | \nac:add-on-key:organization | \nCompany B | \n
| 3 | \nac:add-on-key:employee | \nCharlie | \n
- \n
- Charlie works for Company A: PUT /rest/relation/worksFor/from/content/3/to/content/1 \n
- Charlie works for Company B: PUT /rest/relation/worksFor/from/content/3/to/content/2 \n
ac:add-on-key:employee to use worksFor relation to generate the breadcrumbs.\n Confluence will fetch the relations that were created under name worksFor,\n then display the titles in the creation order of their relations in the search result like this:\n ![\"Quick](\"/cloud/connect/images/confluence-quick-search-breadcrumbs.png\")
\n\n Similarly the site search will display the breadcrumbs as well:\n ![\"Quick](\"/cloud/connect/images/confluence-search-breadcrumbs.png\")
\n\n",
"fieldDescription": "\n\nDefines the breadcrumbs used in\n - \n
- Result of quick search dropdown \n
- Result of site search \n
\n Add-ons have the ability to control the UI components for user to view the custom content.\n\n\n\n\n\n {\n \"contentViewComponent\": {\n \"addonKey\": \"addon-key\",\n \"moduleKey\": \"general-page-module-key\"\n }\n }\n\n\n\n\n
View component example
\n Suppose we already defined a general page module like following:\n\n\n\n\n\n {\n \"url\": \"/my-general-page?content.plugin={content.plugin}&content.id={content.id}&content.version={content.version}&space.key={space.key}&customParameter={ac.customData}\",\n \"name\": {\n \"value\": \"My viewer page\"\n },\n \"key\": \"my-viewer\"\n }\n\n\n\n\n And also the general page is used as a view component in ui support section.\n\n\n\n\n\n {\n \"contentViewComponent\": {\n \"moduleKey\": \"my-viewer\"\n }\n }\n\n\n\n\n When user clicks the title of the corresponding custom content in the search result.\n/my-general-page will be rendered in a iframe with following context parameters being passed.\n
- \n
content.plugin: The content type key of the content. eg:ac:addon-key:module-key\n content.id: The id of the content \n content.version: The version of the content \n space.key: The key of the space which content is contained in \n
{ac.customData} in the example above, it will be substituted with the value\n of the ac.customData parameter that will be taken from the Confluence's current URL. Add-on developers can specify any number of custom parameters, provided that they\n have names that follow this convention: ac.parameter_name.\n If more than one custom parameter with the same name is defined in Confluence's current URL, only the first value will be used.\n For additional information on custom parameters see Context Parameters.\n\n Context Parameters
\n View components support Confluence context parameters. When rendering the view component\n the context variables will be passed to the URL that is defined in the corresponding view component module.\n You can retrieve the content or space information with these parameters via Confluence REST API\n and render it according to your needs.
\n Please consult Context Parameters for what parameters are currently supported.\n\n" }, "componentReference": { "properties": { "addonKey": { "maxLength": 100, "type": "string", "fieldDescription": "\n\nThe add-on key that referenced module was defined in.
\n If not present, the module is assumed to be defined within the same add-on.\n\n" }, "moduleKey": { "maxLength": 100, "type": "string", "fieldDescription": "\n\nModule key of the referenced module.\n\n" } }, "required": [ "moduleKey" ], "shortClassName": "moduleReferenceBean", "type": "object", "title": "Module Reference", "description": "\n\nA reference to a module defined in either this or another add-on\n\n\n\n\n\n {\n \"addonKey\": \"addon-key\",\n \"moduleKey\": \"general-page-module-key\"\n }\n\n\n" }, "apiSupport": { "properties": { "bodyType": { "enum": [ "storage", "STORAGE", "raw", "RAW" ], "type": "string", "fieldDescription": "\n\nDefines the content body type of this custom content.\n Currently supported content body types are:\n
- \n
storage: This is Confluence's default storage representation which can be rendered using the Content Body Conversion API \n raw: This representation is used for storing raw data in the body that is not storage format, this format is opaque to Confluence \n
\n Currently supported content types:\n
- \n
attachment: This custom content can contain attachment. \n comment: This custom content can contain comment. \n - \n Any other content type key of defined custom content.
\n Please refer to The content type key\n for how to construct the content type key.\n \n
read, create and delete.\n It is required that these permissions be granted through the\n space permissions UI in order to perform the given operation.\n\n Otherwise the default permissions will be used.\n\n"
},
"preventDuplicateTitle": {
"type": "boolean",
"fieldDescription": "\n\nDefines whether Confluence should prevent content with duplicate title from being created in the same space or container.\n\n",
"defaultValue": "false"
},
"indexing": {
"$ref": "#/definitions/indexing",
"fieldDescription": "\n\nDefines how this content type will be indexed\n\n"
},
"supportedContainerTypes": {
"items": {
"maxLength": 100,
"type": "string"
},
"type": "array",
"fieldDescription": "\n\nDefines types that this custom content can be contained in.\n Currently supported content types:\n
- \n
space: Treat this custom content as a space directly contained content. \n page: This custom content can be contained in a page. \n blogpost: This custom content can be contained in a blog post. \n - \n Any other content type of defined custom content.
\n Please refer to The content type key\n for how to construct the content type key.\n \n
In the above example, you'll see we specify content type keys in the supportedContainerTypes and supportedChildTypes fields.\n There are 2 categories of content type you can reference – built-in content and custom content.
Built-in content types example
\n The following snippet shows the content type we're defining can:\n- \n
- Be contained in a
spaceor apage\n - Have a child
commentor a childattachment\n
Custom content example
\n The following snippet shows the content type we're defining can:\n- \n
- Be contained in a content with type
type1ortype2, defined in an add-on with the keymy-first-addon\n - Have a child of a content with type
type1ortype2, defined in an add-on with the keymy-second-addon\n
Raw body type custom content example
\n You can define custom content to support a content body with a type ofraw.\n This is useful when you want to store, for example, stringified JSON to the content.\n\n\n\n\n\n {\n \"bodyType\": \"raw\",\n \"supportedContainerTypes\": [\n \"space\"\n ],\n \"supportedChildTypes\": [],\n \"supportedSpacePermissions\": [],\n \"preventDuplicateTitle\": false,\n \"indexing\": {\n \"enabled\": true\n }\n }\n\n\n\n\n Content with a raw body looks like this:\n
\n {\n \"title\": \"My title\",\n \"space\": {\"key\": \"DS\"},\n \"type\": \"ac:add-on-key:module-key\",\n \"body\": {\n \"raw\": {\n \"value\": \"{\\\"field\\\": \\\"value\\\"}\",\n \"representation\": \"raw\"\n }\n }\n }\n The macro parameter indexing property allows apps to hook into the mechanism by which Confluence populates its\n search index for site search. Each time macro is created or updated in Confluence, the value that is stored in\n the macro parameter will be added to the search index.\n The value of this macro parameter will also be used in displaying the excerpt text for search result.
\n\nThis is useful when the body of the macro is not searchable, for example: macros with bodyType: none.\n The app can still provide meaningful search text for this content by storing the extracted information to\n the macro parameter. The data in this macro parameter will get indexed as is without any modification.
Example
\n\n\n\n\n\n {\n \"modules\": {\n \"dynamicContentMacros\": [\n {\n \"renderModes\": {\n \"pdf\": {\n \"url\": \"/render-map-pdf\"\n },\n \"default\": {\n \"url\": \"/render-map-static\"\n }\n },\n \"url\": \"/render-map?pageTitle={page.title}\",\n \"categories\": [],\n \"outputType\": \"block\",\n \"bodyType\": \"none\",\n \"aliases\": [],\n \"name\": {\n \"value\": \"Maps\"\n },\n \"key\": \"dynamic-macro-example\"\n }\n ]\n }\n }\n\n\n" }, "link": { "properties": { "altText": { "maxLength": 1000, "type": "string", "fieldDescription": "\n\nAlternative text that is shown when the element cannot be rendered.\n\n" }, "title": { "maxLength": 1000, "type": "string", "fieldDescription": "\n\nThe title of the link.\n\n" }, "url": { "type": "string", "fieldDescription": "\n\nThe URL of the link. It can be absolute, or relative to the Add-On base URL.\n\n" } }, "required": [ "url" ], "shortClassName": "linkBean", "type": "object", "title": "Link", "description": "\n\nRepresents a link, its optional title and alternative text.\n\nExample
\n\n\n\n\n\n {\n \"link\": {\n \"url\": \"/go-somewhere\",\n \"title\": \"Go Somewhere\",\n \"altText\": \"somewhere\"\n }\n }\n\n\n" }, "autoconvert": { "properties": { "matchers": { "items": { "$ref": "#/definitions/matchers" }, "maxItems": 200, "additionalItems": false, "uniqueItems": false, "type": "array", "fieldDescription": "\n\nThe list of patterns that define what URLs should be matched.\n\n" }, "urlParameter": { "maxLength": 100, "type": "string", "fieldDescription": "\n\nThe name of the macro parameter the matched url will be inserted into.\n\n" } }, "required": [ "urlParameter" ], "shortClassName": "autoconvertBean", "type": "object", "title": "Autoconvert", "description": "\n\nAutoconvert allows your macro to be inserted into the editor when a recognised URL is pasted in by the user.\n You define recognised URL patterns using 'matchers' which are registered in the editor when your add-on is installed.\n\n When the macro is created in the editor, the URL string that triggered the autoconvert will be captured and inserted\n as a parameter on the macro body. You must define the name of this parameter by providing a string value for 'urlParameter'.\n This allows you to access the URL that triggered the autoconvert.\n\nExample
\n\n This example inserts a macro into the editor when a user pastes in certain simple Facebook links.\n\n\n\n\n\n {\n \"renderModes\": {},\n \"url\": \"/dynamic-macro?url={url}\",\n \"categories\": [],\n \"outputType\": \"block\",\n \"bodyType\": \"none\",\n \"aliases\": [],\n \"parameters\": [\n {\n \"identifier\": \"url\",\n \"name\": {\n \"value\": \"URL\"\n },\n \"type\": \"string\",\n \"required\": false,\n \"multiple\": false,\n \"hidden\": false\n }\n ],\n \"autoconvert\": {\n \"urlParameter\": \"url\",\n \"matchers\": [\n {\n \"pattern\": \"https://www.facebook.com/{}/about\"\n },\n {\n \"pattern\": \"https://www.facebook.com/{}/music\"\n },\n {\n \"pattern\": \"https://www.facebook.com/{}/movies/{}\"\n }\n ]\n },\n \"name\": {\n \"value\": \"Dynamic Macro With Autoconvert\"\n },\n \"key\": \"dynamic-macro-with-autoconvert\"\n }\n\n\n" }, "matchers": { "properties": { "pattern": { "maxLength": 1024, "type": "string", "fieldDescription": "\n\nThe pattern is a string that defines a single URL to match.\n\n" } }, "required": [ "pattern" ], "shortClassName": "matcherBean", "type": "object", "title": "Matcher", "description": "\n\nMatchers define a URL string as part of an Autoconvert definition.\n\n Wildcards (parts of the url that should always match, such as as a unique ID) can be defined using a single open and close\n curly bracket such as '{}'. Use a new brace pair for each separate wildcard.\n\n Keep in mind that you'll need to define a separate matcher for each relevant internet protocol (such as http vs https).\n\nExample
\n\n\n\n\n\n {\n \"pattern\": \"https://www.facebook.com/{}/about\"\n }\n\n\n" }, "imagePlaceholder": { "properties": { "applyChrome": { "type": "boolean", "fieldDescription": "\n\nSet to true if the image should have the macro placeholder chrome applied to it.\n\n", "defaultValue": "false" }, "width": { "type": "integer", "fieldDescription": "\n\nThe width in pixels of the image placeholder. Defaults to the natural image width if not specified.\n\n" }, "url": { "format": "uri", "type": "string", "fieldDescription": "\n\nThe URL of the image placeholder. Your image placeholder needs to be hosted remotely at a web-accessible location.\n You can specify the URL as an absolute URL or relative to the add-on's base URL.\n\n The url here doesn't support context parameters. However all the macro parameters will be passed as query parameters to the request.
\n You can use these parameters to dynamically generate the placeholder image.
\n\n Suppose you have a macro defined like this:\n\n\n\n\n\n {\n \"dynamicContentMacros\": {\n \"renderModes\": {},\n \"url\": \"/my-macro\",\n \"categories\": [],\n \"outputType\": \"block\",\n \"bodyType\": \"none\",\n \"aliases\": [],\n \"parameters\": [\n {\n \"identifier\": \"param1\",\n \"name\": {\n \"value\": \"Parameter 1\"\n },\n \"type\": \"string\",\n \"required\": false,\n \"multiple\": false,\n \"hidden\": false\n },\n {\n \"identifier\": \"param2\",\n \"name\": {\n \"value\": \"Parameter 2\"\n },\n \"type\": \"string\",\n \"required\": false,\n \"multiple\": false,\n \"hidden\": false\n }\n ],\n \"imagePlaceholder\": {\n \"url\": \"/images/placeholder.png\",\n \"applyChrome\": false\n },\n \"name\": {\n \"value\": \"My macro with placeholder\"\n },\n \"key\": \"my-macro-key\"\n }\n }\n\n\n\n\n The Confluence editor will pass the parameter values when requesting the placeholder image:\n
/images/placeholder.png?param1=value1¶m2=value2\n\n"
},
"height": {
"type": "integer",
"fieldDescription": "\n\nThe height in pixels of the image placeholder. Defaults to the natural image height if not specified.\n\n"
}
},
"required": [
"url"
],
"shortClassName": "imagePlaceholderBean",
"type": "object",
"title": "Image Placeholder",
"description": "\n\nDefines a macro image placeholder to display in the Confluence editor.\n\n Example
\n\n\n\n\n\n {\n \"imagePlaceholder\": {\n \"width\": 100,\n \"height\": 25,\n \"url\": \"/images/placeholder.png\",\n \"applyChrome\": true\n }\n }\n\n\n" }, "lookAndFeel": { "properties": { "bordersAndDividers": { "$ref": "#/definitions/bordersAndDividers", "fieldDescription": "\n\nDeclares styles to be applied on borders and dividers\n\n" }, "headings": { "$ref": "#/definitions/headings", "fieldDescription": "\n\nDeclares styles to be applied on the headings of the content (HTML h1 to h6 tags)\n\n" }, "header": { "$ref": "#/definitions/header", "fieldDescription": "\n\nDeclares styles to be applied on the header bar\n\n" }, "links": { "$ref": "#/definitions/links", "fieldDescription": "\n\nDeclares styles to be applied on the links in the content (HTML a tags)\n\n" }, "menus": { "$ref": "#/definitions/menus", "fieldDescription": "\n\nDeclares styles to be applied on menus, e.g. Space Tools menu, Action menu (expanding at the ellipsis)\n\n" }, "content": { "$ref": "#/definitions/content", "fieldDescription": "\n\nDeclares styles to be applied on the content, including Page Content, Blogpost Content, Page Collector, Blogpost Collector\n\n" } }, "required": [ "bordersAndDividers", "headings", "header", "links", "menus", "content" ], "shortClassName": "lookAndFeelBean", "type": "object", "title": "LookAndFeel", "description": "\n\nDefines custom look and feel experience.\n\nExample
\n\n\n\n\n\n {\n \"headings\": {\n \"color\": \"#333333\"\n },\n \"links\": {\n \"color\": \"#3572B0\"\n },\n \"menus\": {\n \"hoverOrFocus\": {\n \"backgroundColor\": \"#3873AE\"\n },\n \"color\": \"#000000\"\n },\n \"bordersAndDividers\": {\n \"color\": \"#0D0E0E\"\n },\n \"header\": {\n \"backgroundColor\": \"#661F2D\",\n \"button\": {\n \"backgroundColor\": \"#894E59\",\n \"color\": \"#FFFFFF\"\n },\n \"primaryNavigation\": {\n \"hoverOrFocus\": {\n \"backgroundColor\": \"#863647\",\n \"color\": \"#FFFFFF\"\n },\n \"color\": \"#FFFFFF\"\n },\n \"secondaryNavigation\": {\n \"hoverOrFocus\": {\n \"backgroundColor\": \"#863647\",\n \"color\": \"#FFFFFF\"\n },\n \"color\": \"#000000\"\n },\n \"search\": {\n \"backgroundColor\": \"#9A636B\",\n \"color\": \"#FFFFFF\"\n }\n },\n \"content\": {\n \"screen\": {\n \"layer\": {\n \"width\": \"100%\",\n \"height\": \"250px\",\n \"backgroundImage\": \"url('http://path/to/img/skyline.jpg')\",\n \"backgroundSize\": \"cover\",\n \"backgroundRepeat\": \"no-repeat\"\n },\n \"gutterTop\": \"20px\",\n \"gutterRight\": \"small\",\n \"gutterBottom\": \"10px\",\n \"gutterLeft\": \"small\",\n \"background\": \"linear-gradient(45deg, rgba(176,104,112,1) 0%, rgba(244,212,216,1) 100%)\"\n },\n \"container\": {\n \"padding\": \"0 20px\",\n \"borderRadius\": \"10px\",\n \"background\": \"#F4D4D8\"\n },\n \"header\": {\n \"padding\": \"20px 0 90px 20px\",\n \"borderRadius\": \"5px 5px 0 0\",\n \"backgroundColor\": \"rgba(0, 0, 0, 0.2)\"\n },\n \"body\": {\n \"padding\": \"10px\",\n \"borderRadius\": \"0 0 5px 5px\",\n \"background\": \"#FFFFFF\"\n }\n }\n }\n\n\n" }, "bordersAndDividers": { "properties": { "color": { "pattern": "^#([\\da-fA-F]){3}$|^#([\\da-fA-F]){6}$|^rgb\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*\\)$|^rgba\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$|^rgb\\((\\d+)%,\\s*(\\d+)%,\\s*(\\d+)%\\)$|^hsl\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*\\)$|^hsla\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$", "type": "string", "fieldDescription": "\n\nDeclares the color to be applied to the borders and dividers.\n The supported values include RGB(A), HSL(A), HEX codes, except for color names.
\n\n" } }, "required": [ "color" ], "shortClassName": "bordersAndDividersBean", "type": "object", "title": "BordersAndDividers", "description": "\n\nDefines styles to be applied on the borders and dividers.\n\n
Example
\n\n\n\n\n\n {\n \"color\": \"#0D0E0E\"\n }\n\n\n" }, "headings": { "properties": { "color": { "pattern": "^#([\\da-fA-F]){3}$|^#([\\da-fA-F]){6}$|^rgb\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*\\)$|^rgba\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$|^rgb\\((\\d+)%,\\s*(\\d+)%,\\s*(\\d+)%\\)$|^hsl\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*\\)$|^hsla\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$", "type": "string", "fieldDescription": "\n\nDeclares color to be applied on the headings of the content (HTML h1 to h6 tags).\n The supported values include RGB(A), HSL(A), HEX codes, except for color names.
\n\n" } }, "required": [ "color" ], "shortClassName": "headingsBean", "type": "object", "title": "Headings", "description": "\n\nDefines styles to be applied on the headings of the content (HTML h1 to b tags).\n\n
Example
\n\n\n\n\n\n {\n \"color\": \"#333333\"\n }\n\n\n" }, "header": { "properties": { "button": { "$ref": "#/definitions/button", "fieldDescription": "\n\nDeclares styles to be applied on the button on the header\n\n" }, "backgroundColor": { "pattern": "^#([\\da-fA-F]){3}$|^#([\\da-fA-F]){6}$|^rgb\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*\\)$|^rgba\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$|^rgb\\((\\d+)%,\\s*(\\d+)%,\\s*(\\d+)%\\)$|^hsl\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*\\)$|^hsla\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$", "type": "string", "fieldDescription": "\n\nDeclares color to be applied on the header background.\n The supported values include RGB(A), HSL(A), HEX codes, except for color names.
\n\n" }, "primaryNavigation": { "$ref": "#/definitions/primaryNavigation", "fieldDescription": "\n\nDeclares styles to be applied on the primary navigation\n\n" }, "search": { "$ref": "#/definitions/search", "fieldDescription": "\n\nDeclares styles to be applied on the search field\n\n" }, "secondaryNavigation": { "$ref": "#/definitions/secondaryNavigation", "fieldDescription": "\n\nDeclares styles to be applied on the secondary navigation\n\n" } }, "required": [ "button", "backgroundColor", "primaryNavigation", "search", "secondaryNavigation" ], "shortClassName": "headerBean", "type": "object", "title": "Header", "description": "\n\nDefines styles to be applied on the header.\n\n
Example
\n\n\n\n\n\n {\n \"backgroundColor\": \"#661F2D\",\n \"button\": {\n \"backgroundColor\": \"#894E59\",\n \"color\": \"#FFFFFF\"\n },\n \"primaryNavigation\": {\n \"hoverOrFocus\": {\n \"backgroundColor\": \"#863647\",\n \"color\": \"#FFFFFF\"\n },\n \"color\": \"#FFFFFF\"\n },\n \"secondaryNavigation\": {\n \"hoverOrFocus\": {\n \"backgroundColor\": \"#863647\",\n \"color\": \"#FFFFFF\"\n },\n \"color\": \"#000000\"\n },\n \"search\": {\n \"backgroundColor\": \"#9A636B\",\n \"color\": \"#FFFFFF\"\n }\n }\n\n\n" }, "button": { "properties": { "backgroundColor": { "pattern": "^#([\\da-fA-F]){3}$|^#([\\da-fA-F]){6}$|^rgb\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*\\)$|^rgba\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$|^rgb\\((\\d+)%,\\s*(\\d+)%,\\s*(\\d+)%\\)$|^hsl\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*\\)$|^hsla\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$", "type": "string", "fieldDescription": "\n\nDeclares the color to be applied to the button background.\n The supported values include RGB(A), HSL(A), HEX codes, except for color names.
\n\n" }, "color": { "pattern": "^#([\\da-fA-F]){3}$|^#([\\da-fA-F]){6}$|^rgb\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*\\)$|^rgba\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$|^rgb\\((\\d+)%,\\s*(\\d+)%,\\s*(\\d+)%\\)$|^hsl\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*\\)$|^hsla\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$", "type": "string", "fieldDescription": "\n\nDeclares the color to be applied to the button text.
\n The supported values include RGB(A), HSL(A), HEX codes, except for color names.
\n\n" } }, "required": [ "backgroundColor", "color" ], "shortClassName": "buttonBean", "type": "object", "title": "Button", "description": "\n\nDefines styles to be applied on the button.\n\n
Example
\n\n\n\n\n\n {\n \"backgroundColor\": \"#894E59\",\n \"color\": \"#FFFFFF\"\n }\n\n\n" }, "primaryNavigation": { "properties": { "color": { "pattern": "^#([\\da-fA-F]){3}$|^#([\\da-fA-F]){6}$|^rgb\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*\\)$|^rgba\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$|^rgb\\((\\d+)%,\\s*(\\d+)%,\\s*(\\d+)%\\)$|^hsl\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*\\)$|^hsla\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$", "type": "string", "fieldDescription": "\n\nDeclares the color to be applied to the button background on the navigation.\n The supported values include RGB(A), HSL(A), HEX codes, except for color names.
\n\n" }, "hoverOrFocus": { "$ref": "#/definitions/hoverOrFocus", "fieldDescription": "\n\nDeclares the style to be applied to the navigation when it is hovered or focused.\n\n" } }, "required": [ "color", "hoverOrFocus" ], "shortClassName": "primaryNavigationBean", "type": "object", "title": "PrimaryNavigation", "description": "\n\nDefines styles to be applied on the primary navigation.\n\n
Example
\n\n\n\n\n\n {\n \"hoverOrFocus\": {\n \"backgroundColor\": \"#863647\",\n \"color\": \"#FFFFFF\"\n },\n \"color\": \"#FFFFFF\"\n }\n\n\n" }, "hoverOrFocus": { "properties": { "backgroundColor": { "pattern": "^#([\\da-fA-F]){3}$|^#([\\da-fA-F]){6}$|^rgb\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*\\)$|^rgba\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$|^rgb\\((\\d+)%,\\s*(\\d+)%,\\s*(\\d+)%\\)$|^hsl\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*\\)$|^hsla\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$", "type": "string", "fieldDescription": "\n\nDeclares color to be applied on the background of the component when it is hovered or focused.\n The supported values include RGB(A), HSL(A), HEX codes, except for color names.
\n\n" }, "color": { "pattern": "^#([\\da-fA-F]){3}$|^#([\\da-fA-F]){6}$|^rgb\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*\\)$|^rgba\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$|^rgb\\((\\d+)%,\\s*(\\d+)%,\\s*(\\d+)%\\)$|^hsl\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*\\)$|^hsla\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$", "type": "string", "fieldDescription": "\n\nDeclares color to be applied on the text in the component when it is hovered or focused.
\n The supported values include RGB(A), HSL(A), HEX codes, except for color names.
\n\n" } }, "required": [ "backgroundColor" ], "shortClassName": "hoverOrFocusBean", "type": "object", "description": "\n\n" }, "search": { "properties": { "backgroundColor": { "pattern": "^#([\\da-fA-F]){3}$|^#([\\da-fA-F]){6}$|^rgb\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*\\)$|^rgba\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$|^rgb\\((\\d+)%,\\s*(\\d+)%,\\s*(\\d+)%\\)$|^hsl\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*\\)$|^hsla\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$", "type": "string", "fieldDescription": "\n\nDeclares color to be applied on the background of the search field.
\n The supported values include RGB(A), HSL(A), HEX codes, except for color names.
\n\n" }, "color": { "pattern": "^#([\\da-fA-F]){3}$|^#([\\da-fA-F]){6}$|^rgb\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*\\)$|^rgba\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$|^rgb\\((\\d+)%,\\s*(\\d+)%,\\s*(\\d+)%\\)$|^hsl\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*\\)$|^hsla\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$", "type": "string", "fieldDescription": "\n\nDeclares color to be applied on the text in the search field.
\n The supported values include RGB(A), HSL(A), HEX codes, except for color names.
\n\n" } }, "required": [ "backgroundColor", "color" ], "shortClassName": "searchFieldBean", "type": "object", "title": "Search", "description": "\n\nDefines styles to be applied on the search field.\n\n
Example
\n\n\n\n\n\n {\n \"backgroundColor\": \"#9A636B\",\n \"color\": \"#FFFFFF\"\n }\n\n\n" }, "secondaryNavigation": { "properties": { "color": { "pattern": "^#([\\da-fA-F]){3}$|^#([\\da-fA-F]){6}$|^rgb\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*\\)$|^rgba\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$|^rgb\\((\\d+)%,\\s*(\\d+)%,\\s*(\\d+)%\\)$|^hsl\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*\\)$|^hsla\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$", "type": "string", "fieldDescription": "\n\nDeclares the color to be applied to the button background on the navigation.\n The supported values include RGB(A), HSL(A), HEX codes, except for color names.
\n\n" }, "hoverOrFocus": { "$ref": "#/definitions/hoverOrFocus", "fieldDescription": "\n\nDeclares the style to be applied to the navigation when it is hovered or focused.\n\n" } }, "required": [ "color", "hoverOrFocus" ], "shortClassName": "secondaryNavigationBean", "type": "object", "title": "SecondaryNavigation", "description": "\n\nDefines styles to be applied on the secondary navigation.\n\n
Example
\n\n\n\n\n\n {\n \"hoverOrFocus\": {\n \"backgroundColor\": \"#863647\",\n \"color\": \"#FFFFFF\"\n },\n \"color\": \"#000000\"\n }\n\n\n" }, "links": { "properties": { "color": { "pattern": "^#([\\da-fA-F]){3}$|^#([\\da-fA-F]){6}$|^rgb\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*\\)$|^rgba\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$|^rgb\\((\\d+)%,\\s*(\\d+)%,\\s*(\\d+)%\\)$|^hsl\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*\\)$|^hsla\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$", "type": "string", "fieldDescription": "\n\nDeclares color to be applied on the links.\n The supported values include RGB(A), HSL(A), HEX codes, except for color names.
\n\n" } }, "required": [ "color" ], "shortClassName": "linksBean", "type": "object", "title": "Links", "description": "\n\nDefines styles to be applied on the links.\n\n
Example
\n\n\n\n\n\n {\n \"color\": \"#3572B0\"\n }\n\n\n" }, "menus": { "properties": { "color": { "pattern": "^#([\\da-fA-F]){3}$|^#([\\da-fA-F]){6}$|^rgb\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*\\)$|^rgba\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$|^rgb\\((\\d+)%,\\s*(\\d+)%,\\s*(\\d+)%\\)$|^hsl\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*\\)$|^hsla\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$", "type": "string", "fieldDescription": "\n\nDeclares color to be applied on the text in the menus.\n The supported values include RGB(A), HSL(A), HEX codes, except for color names.
\n\n" }, "hoverOrFocus": { "$ref": "#/definitions/hoverOrFocus", "fieldDescription": "\n\nDeclares style to be applied on the menu when it is hovered or focused.\n\n" } }, "required": [ "color", "hoverOrFocus" ], "shortClassName": "menusBean", "type": "object", "title": "Menus", "description": "\n\nDefines styles to be applied on menus.\n\n
Example
\n\n\n\n\n\n {\n \"hoverOrFocus\": {\n \"backgroundColor\": \"#3873AE\"\n },\n \"color\": \"#000000\"\n }\n\n\n" }, "content": { "properties": { "container": { "$ref": "#/definitions/container", "fieldDescription": "\n\nDeclares styles to be applied on the container of content view\n\n" }, "screen": { "$ref": "#/definitions/screen", "fieldDescription": "\n\nDeclares styles to be applied on the underlay of content view\n\n" }, "header": { "$ref": "#/definitions/contentHeader", "fieldDescription": "\n\nDeclares styles to be applied on the header of content view\n\n" }, "body": { "$ref": "#/definitions/body", "fieldDescription": "\n\nDeclares styles to be applied on the body of content view\n\n" } }, "required": [ "container", "screen", "header", "body" ], "shortClassName": "contentBean", "type": "object", "title": "Content", "description": "\n\nDefines styles to be applied on the content view.\n\nExample
\n\n\n\n\n\n {\n \"screen\": {\n \"layer\": {\n \"width\": \"100%\",\n \"height\": \"250px\",\n \"backgroundImage\": \"url('http://path/to/img/skyline.jpg')\",\n \"backgroundSize\": \"cover\",\n \"backgroundRepeat\": \"no-repeat\"\n },\n \"gutterTop\": \"20px\",\n \"gutterRight\": \"small\",\n \"gutterBottom\": \"10px\",\n \"gutterLeft\": \"small\",\n \"background\": \"linear-gradient(45deg, rgba(176,104,112,1) 0%, rgba(244,212,216,1) 100%)\"\n },\n \"container\": {\n \"padding\": \"0 20px\",\n \"borderRadius\": \"10px\",\n \"background\": \"#F4D4D8\"\n },\n \"header\": {\n \"padding\": \"20px 0 90px 20px\",\n \"borderRadius\": \"5px 5px 0 0\",\n \"backgroundColor\": \"rgba(0, 0, 0, 0.2)\"\n },\n \"body\": {\n \"padding\": \"10px\",\n \"borderRadius\": \"0 0 5px 5px\",\n \"background\": \"#FFFFFF\"\n }\n }\n\n\n" }, "container": { "properties": { "backgroundClip": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background clip property to be applied for the content view.\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-clip MDN reference for details.\n\n" }, "padding": { "pattern": "^(0|(\\d*)(em|ex|in|cm|mm|pt|pc|px|%))( 0| (\\d*)(em|ex|in|cm|mm|pt|pc|px|%)){0,3}$", "type": "string", "fieldDescription": "\n\nDeclares the padding property to be applied on the container, body, header of content view.
\n The format of inputs should be in CSS style where the input can have from one to four elements\n followed by length units (em, ex, in, cm, mm, pt, pc, px) or percentage (%).
\n\n" }, "backgroundColor": { "pattern": "^#([\\da-fA-F]){3}$|^#([\\da-fA-F]){6}$|^rgb\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*\\)$|^rgba\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$|^rgb\\((\\d+)%,\\s*(\\d+)%,\\s*(\\d+)%\\)$|^hsl\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*\\)$|^hsla\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$", "type": "string", "fieldDescription": "\n\nDeclares color to be applied to the content background.
\n The supported values include RGB(A), HSL(A), HEX codes, except for color names.
\n\n" }, "backgroundAttachment": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background attachment property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-attachment MDN reference for details.\n\n" }, "borderRadius": { "pattern": "^(0|(\\d*)(em|ex|in|cm|mm|pt|pc|px|%))( 0| (\\d*)(em|ex|in|cm|mm|pt|pc|px|%)){0,3}$", "type": "string", "fieldDescription": "\n\nDeclares the border radius property to be applied on the container, body, header of content view.
\n The format of inputs should be in CSS style where the input can have from one to four elements\n followed by length units (em, ex, in, cm, mm, pt, pc, px) or percentage (%).
\n\n" }, "background": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background shorthand property to set all the background properties in one declaration.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background MDN reference for details.\n\n" }, "backgroundImage": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background image property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-image MDN reference for details.\n\n" }, "backgroundSize": { "pattern": "auto|cover|contain|initial|inherit|^(0|(\\d*)(em|ex|in|cm|mm|pt|pc|px|%))( 0| (\\d*)(em|ex|in|cm|mm|pt|pc|px|%)){0,3}$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background repeat property to be applied for the content view.
\n Values must contain \"auto\", \"cover\", \"contain\", \"initial\", \"inherit\", length or percentage.
\n See the background-size MDN reference for details.\n\n" }, "backgroundPosition": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background position property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-position MDN reference for details.\n\n" }, "backgroundBlendMode": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background blend mode property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-blend-more MDN reference for details.\n\n" }, "backgroundRepeat": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background size property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-repeat MDN reference for details.\n\n" }, "backgroundOrigin": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background origin property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-origin MDN reference for details.\n\n" } }, "required": [ "padding", "borderRadius" ], "shortClassName": "containerBean", "type": "object", "title": "Container", "description": "\n\n
\n Defines styles to be applied to the container of content view.\n
\n\n The supported properties include shorthand background and all CSS background properties.\n The keys are the camelCased versions of corresponding CSS properties, like backgroundImage,\n backgroundColor, backgroundSize, backgroundPosition, backgroundRepeat,\n backgroundClip, backgroundOrigin, backgroundAttachment, and backgroundBlendMode.\n
\n\nExample
\n\n\n\n\n\n {\n \"padding\": \"0 20px\",\n \"borderRadius\": \"10px\",\n \"background\": \"#F4D4D8\"\n }\n\n\n" }, "screen": { "properties": { "gutterTop": { "pattern": "none|default|^(0|(\\d*)(em|ex|in|cm|mm|pt|pc|px|%))$", "type": "string", "fieldDescription": "\n\nDeclares the gutter top property to be applied on the content view.\n The valid values include \"none\", \"default\", length or percentage.\n\n" }, "backgroundColor": { "pattern": "^#([\\da-fA-F]){3}$|^#([\\da-fA-F]){6}$|^rgb\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*\\)$|^rgba\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$|^rgb\\((\\d+)%,\\s*(\\d+)%,\\s*(\\d+)%\\)$|^hsl\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*\\)$|^hsla\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$", "type": "string", "fieldDescription": "\n\nDeclares color to be applied to the content background.
\n The supported values include RGB(A), HSL(A), HEX codes, except for color names.
\n\n" }, "backgroundAttachment": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background attachment property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-attachment MDN reference for details.\n\n" }, "backgroundImage": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background image property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-image MDN reference for details.\n\n" }, "layer": { "$ref": "#/definitions/layer", "fieldDescription": "\n\n" }, "gutterRight": { "pattern": "none|default|small|medium|large", "type": "string", "fieldDescription": "\n\nDeclares the gutter right property to be applied on the content view.
\n The valid values include \"none\", \"default\", \"small\", \"medium\", \"large\".
\n\n" }, "gutterLeft": { "pattern": "none|default|small|medium|large", "type": "string", "fieldDescription": "\n\nDeclares the gutter left property to be applied on the content view.
\n The valid values include \"none\", \"default\", \"small\", \"medium\", \"large\".\n\n" }, "backgroundClip": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background clip property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-clip MDN reference for details.\n\n" }, "background": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background shorthand property to set all the background properties in one declaration.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background MDN reference for details.\n\n" }, "backgroundSize": { "pattern": "auto|cover|contain|initial|inherit|^(0|(\\d*)(em|ex|in|cm|mm|pt|pc|px|%))( 0| (\\d*)(em|ex|in|cm|mm|pt|pc|px|%)){0,3}$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background repeat property to be applied for the content view.
\n Values must contain \"auto\", \"cover\", \"contain\", \"initial\", \"inherit\", length or percentage.
\n See the background-size MDN reference for details.\n\n" }, "backgroundPosition": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background position property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-position MDN reference for details.\n\n" }, "backgroundBlendMode": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background blend mode property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-blend-more MDN reference for details.\n\n" }, "backgroundRepeat": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background size property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-repeat MDN reference for details.\n\n" }, "backgroundOrigin": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background origin property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-origin MDN reference for details.\n\n" }, "gutterBottom": { "pattern": "none|default|^(0|(\\d*)(em|ex|in|cm|mm|pt|pc|px|%))$", "type": "string", "fieldDescription": "\n\nDeclares the gutter bottom property to be applied on the content view.
\n The valid values include \"none\", \"default\", length or percentage.\n\n" } }, "required": [ "gutterRight", "gutterLeft", "gutterTop", "gutterBottom" ], "shortClassName": "screenBean", "type": "object", "title": "Screen", "description": "\n\n
\n Defines styles to be applied on the underlay of content view.\n
\n\n The supported properties include shorthand background and all CSS background element properties.\n The keys are the camelCased versions of corresponding CSS properties, like backgroundImage,\n backgroundColor, backgroundSize, backgroundPosition, backgroundRepeat,\n backgroundClip, backgroundOrigin, backgroundAttachment, and backgroundBlendMode.\n
\n\nExample
\n\n\n\n\n\n {\n \"layer\": {\n \"width\": \"100%\",\n \"height\": \"250px\",\n \"backgroundImage\": \"url('http://path/to/img/skyline.jpg')\",\n \"backgroundSize\": \"cover\",\n \"backgroundRepeat\": \"no-repeat\"\n },\n \"gutterTop\": \"20px\",\n \"gutterRight\": \"small\",\n \"gutterBottom\": \"10px\",\n \"gutterLeft\": \"small\",\n \"background\": \"linear-gradient(45deg, rgba(176,104,112,1) 0%, rgba(244,212,216,1) 100%)\"\n }\n\n\n" }, "layer": { "properties": { "backgroundClip": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background clip property to be applied for the content view.\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-clip MDN reference for details.\n\n" }, "backgroundColor": { "pattern": "^#([\\da-fA-F]){3}$|^#([\\da-fA-F]){6}$|^rgb\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*\\)$|^rgba\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$|^rgb\\((\\d+)%,\\s*(\\d+)%,\\s*(\\d+)%\\)$|^hsl\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*\\)$|^hsla\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$", "type": "string", "fieldDescription": "\n\nDeclares color to be applied to the content background.
\n The supported values include RGB(A), HSL(A), HEX codes, except for color names.
\n\n" }, "backgroundAttachment": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background attachment property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-attachment MDN reference for details.\n\n" }, "background": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background shorthand property to set all the background properties in one declaration.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background MDN reference for details.\n\n" }, "backgroundImage": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background image property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-image MDN reference for details.\n\n" }, "width": { "pattern": "^(0|(\\d*)(em|ex|in|cm|mm|pt|pc|px|%))$", "type": "string", "fieldDescription": "\n\nDeclares the width property to be applied on the layer of underlay of content view.
\n The format of inputs should be in CSS style where the input has only one element\n followed by length units (em, ex, in, cm, mm, pt, pc, px) or percentage (%).
\n\n" }, "backgroundSize": { "pattern": "auto|cover|contain|initial|inherit|^(0|(\\d*)(em|ex|in|cm|mm|pt|pc|px|%))( 0| (\\d*)(em|ex|in|cm|mm|pt|pc|px|%)){0,3}$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background repeat property to be applied for the content view.
\n Values must contain \"auto\", \"cover\", \"contain\", \"initial\", \"inherit\", length or percentage.
\n See the background-size MDN reference for details.\n\n" }, "backgroundPosition": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background position property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-position MDN reference for details.\n\n" }, "backgroundBlendMode": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background blend mode property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-blend-more MDN reference for details.\n\n" }, "backgroundRepeat": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background size property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-repeat MDN reference for details.\n\n" }, "backgroundOrigin": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background origin property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-origin MDN reference for details.\n\n" }, "height": { "pattern": "^(0|(\\d*)(em|ex|in|cm|mm|pt|pc|px|%))$", "type": "string", "fieldDescription": "\n\nDeclares the height property to be applied on the layer of underlay of content view.
\n The format of inputs should be in CSS style where the input has only one element\n followed by length units (em, ex, in, cm, mm, pt, pc, px) or percentage (%).
\n\n" } }, "required": [ "width", "height" ], "shortClassName": "layerScreenBean", "type": "object", "title": "Layer", "description": "\n\n
\n Defines styles to be applied on the layer of the underlay of content view.\n
\n\n The supported properties include shorthand background and all CSS background properties.\n The keys are the camelCased versions of corresponding CSS properties, like backgroundImage,\n backgroundColor, backgroundSize, backgroundPosition, backgroundRepeat,\n backgroundClip, backgroundOrigin, backgroundAttachment, and backgroundBlendMode.\n
\n\nExample
\n\n\n\n\n\n {\n \"width\": \"100%\",\n \"height\": \"250px\",\n \"backgroundImage\": \"url('http://path/to/img/skyline.jpg')\",\n \"backgroundSize\": \"cover\",\n \"backgroundRepeat\": \"no-repeat\"\n }\n\n\n" }, "contentHeader": { "properties": { "backgroundClip": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background clip property to be applied for the content view.\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-clip MDN reference for details.\n\n" }, "padding": { "pattern": "^(0|(\\d*)(em|ex|in|cm|mm|pt|pc|px|%))( 0| (\\d*)(em|ex|in|cm|mm|pt|pc|px|%)){0,3}$", "type": "string", "fieldDescription": "\n\nDeclares the padding property to be applied on the container, body, header of content view.
\n The format of inputs should be in CSS style where the input can have from one to four elements\n followed by length units (em, ex, in, cm, mm, pt, pc, px) or percentage (%).
\n\n" }, "backgroundColor": { "pattern": "^#([\\da-fA-F]){3}$|^#([\\da-fA-F]){6}$|^rgb\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*\\)$|^rgba\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$|^rgb\\((\\d+)%,\\s*(\\d+)%,\\s*(\\d+)%\\)$|^hsl\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*\\)$|^hsla\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$", "type": "string", "fieldDescription": "\n\nDeclares color to be applied to the content background.
\n The supported values include RGB(A), HSL(A), HEX codes, except for color names.
\n\n" }, "backgroundAttachment": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background attachment property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-attachment MDN reference for details.\n\n" }, "borderRadius": { "pattern": "^(0|(\\d*)(em|ex|in|cm|mm|pt|pc|px|%))( 0| (\\d*)(em|ex|in|cm|mm|pt|pc|px|%)){0,3}$", "type": "string", "fieldDescription": "\n\nDeclares the border radius property to be applied on the container, body, header of content view.
\n The format of inputs should be in CSS style where the input can have from one to four elements\n followed by length units (em, ex, in, cm, mm, pt, pc, px) or percentage (%).
\n\n" }, "background": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background shorthand property to set all the background properties in one declaration.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background MDN reference for details.\n\n" }, "backgroundImage": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background image property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-image MDN reference for details.\n\n" }, "backgroundSize": { "pattern": "auto|cover|contain|initial|inherit|^(0|(\\d*)(em|ex|in|cm|mm|pt|pc|px|%))( 0| (\\d*)(em|ex|in|cm|mm|pt|pc|px|%)){0,3}$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background repeat property to be applied for the content view.
\n Values must contain \"auto\", \"cover\", \"contain\", \"initial\", \"inherit\", length or percentage.
\n See the background-size MDN reference for details.\n\n" }, "backgroundPosition": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background position property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-position MDN reference for details.\n\n" }, "backgroundBlendMode": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background blend mode property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-blend-more MDN reference for details.\n\n" }, "backgroundRepeat": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background size property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-repeat MDN reference for details.\n\n" }, "backgroundOrigin": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background origin property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-origin MDN reference for details.\n\n" } }, "required": [ "padding", "borderRadius" ], "shortClassName": "contentHeaderBean", "type": "object", "title": "ContentHeader", "description": "\n\n
\n Defines styles to be applied on the header of content view.\n
\n\n The supported properties include shorthand background and all CSS background properties.\n The keys are the camelCased versions of corresponding CSS properties, like backgroundImage,\n backgroundColor, backgroundSize, backgroundPosition, backgroundRepeat,\n backgroundClip, backgroundOrigin, backgroundAttachment, and backgroundBlendMode.\n
\n\nExample
\n\n\n\n\n\n {\n \"padding\": \"20px 0 90px 20px\",\n \"borderRadius\": \"5px 5px 0 0\",\n \"backgroundColor\": \"rgba(0, 0, 0, 0.2)\"\n }\n\n\n" }, "body": { "properties": { "backgroundClip": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background clip property to be applied for the content view.\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-clip MDN reference for details.\n\n" }, "padding": { "pattern": "^(0|(\\d*)(em|ex|in|cm|mm|pt|pc|px|%))( 0| (\\d*)(em|ex|in|cm|mm|pt|pc|px|%)){0,3}$", "type": "string", "fieldDescription": "\n\nDeclares the padding property to be applied on the container, body, header of content view.
\n The format of inputs should be in CSS style where the input can have from one to four elements\n followed by length units (em, ex, in, cm, mm, pt, pc, px) or percentage (%).
\n\n" }, "backgroundColor": { "pattern": "^#([\\da-fA-F]){3}$|^#([\\da-fA-F]){6}$|^rgb\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*\\)$|^rgba\\(\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*(0|[1-9]\\d?|1\\d\\d?|2[0-4]\\d|25[0-5])\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$|^rgb\\((\\d+)%,\\s*(\\d+)%,\\s*(\\d+)%\\)$|^hsl\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*\\)$|^hsla\\(\\s*(0|[1-9]\\d?|[12]\\d\\d|3[0-5]\\d)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0|[1-9]\\d?|100)%)\\s*,\\s*((0.[0-9]*)|[01])\\s*\\)$", "type": "string", "fieldDescription": "\n\nDeclares color to be applied to the content background.
\n The supported values include RGB(A), HSL(A), HEX codes, except for color names.
\n\n" }, "backgroundAttachment": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background attachment property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-attachment MDN reference for details.\n\n" }, "borderRadius": { "pattern": "^(0|(\\d*)(em|ex|in|cm|mm|pt|pc|px|%))( 0| (\\d*)(em|ex|in|cm|mm|pt|pc|px|%)){0,3}$", "type": "string", "fieldDescription": "\n\nDeclares the border radius property to be applied on the container, body, header of content view.
\n The format of inputs should be in CSS style where the input can have from one to four elements\n followed by length units (em, ex, in, cm, mm, pt, pc, px) or percentage (%).
\n\n" }, "background": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background shorthand property to set all the background properties in one declaration.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background MDN reference for details.\n\n" }, "backgroundImage": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background image property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-image MDN reference for details.\n\n" }, "backgroundSize": { "pattern": "auto|cover|contain|initial|inherit|^(0|(\\d*)(em|ex|in|cm|mm|pt|pc|px|%))( 0| (\\d*)(em|ex|in|cm|mm|pt|pc|px|%)){0,3}$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background repeat property to be applied for the content view.
\n Values must contain \"auto\", \"cover\", \"contain\", \"initial\", \"inherit\", length or percentage.
\n See the background-size MDN reference for details.\n\n" }, "backgroundPosition": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background position property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-position MDN reference for details.\n\n" }, "backgroundBlendMode": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background blend mode property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-blend-more MDN reference for details.\n\n" }, "backgroundRepeat": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background size property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-repeat MDN reference for details.\n\n" }, "backgroundOrigin": { "pattern": "^((?![;|}]).)*$", "type": "string", "fieldDescription": "\n\nDeclares the CSS background origin property to be applied for the content view.
\n Values must not contain semi-colon \";\" and curly bracket \"}\".
\n See the background-origin MDN reference for details.\n\n" } }, "required": [ "padding", "borderRadius" ], "shortClassName": "contentBodyBean", "type": "object", "title": "Body", "description": "\n\n
\n Defines styles to be applied on the body of content view.\n
\n\n The supported properties include background shorthand property and all CSS background element properties.\n The keys are the camelCased versions of corresponding CSS properties, like backgroundImage,\n backgroundColor, backgroundSize, backgroundPosition, backgroundRepeat,\n backgroundClip, backgroundOrigin, backgroundAttachment, and backgroundBlendMode.\n
\n\nExample
\n\n\n\n\n\n {\n \"padding\": \"10px\",\n \"borderRadius\": \"0 0 5px 5px\",\n \"background\": \"#FFFFFF\"\n }\n\n\n" } }, "additionalProperties": false, "type": "object", "properties": { "app": { "$ref": "#/definitions/AppSchema", "title": "app" }, "connectModules": { "$ref": "#/definitions/ConnectModuleSchema", "title": "connectModules" }, "modules": { "$ref": "#/definitions/ModuleSchema", "title": "modules" }, "permissions": { "$ref": "#/definitions/AppPermissionsSchema", "title": "permissions" }, "resources": { "$ref": "#/definitions/HostedResourcesSchema", "title": "resources" }, "remotes": { "$ref": "#/definitions/RemotesSchema", "title": "remotes" }, "providers": { "$ref": "#/definitions/ProvidersSchema", "title": "providers" } }, "required": [ "app" ] }