\n A Connect keyboard shortcut can perform one of three actions:\n navigate to a page, open a dialog module, or invoke an action represented by a web-item on a page.\n Pages, dialog modules and web-items referenced by the shortcut must be declared by the same add-on.\n\n A shortcut is identified by a sequence of letters which need to be pressed in order for the shortcut action to be invoked.\n You cannot declare shortcuts that would shadow shortcuts defined by the product.\n A shortcut shadows all shortcuts which start with its sequence.\n\n On the other hand, it's possible to shadow shortcuts defined by the same or other add-ons, although those won't\n be accessible anymore.\n\n In case multiple shortcuts have the same sequence, there is no guarantee on which will be invoked.\n
\n\n\"{\"label\": {\"color\": \"red\", \"text\":\"connect\"}} the valid objectName\n referencing the color is label.color.\n\n It is important to note that the objectName can refer to an array type, where the 'type' field in the extraction should\n be the type of each element in the specified array.\n\n"
},
"alias": {
"type": "string",
"fieldDescription": "\n\nThe name, under which this property will be searchable with JQL.\n\n"
},
"type": {
"enum": [
"number",
"NUMBER",
"text",
"TEXT",
"string",
"STRING",
"user",
"USER",
"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`, which is indexed as a number and allows the range ordering and searching on this field.\n * `text`, which is tokenized before indexing and allows searching for particular words.\n * `string` which is indexed as is and allows searching for the exact phase only.\n * `user`, which is indexed as a user and allows user-based searching. The expected value is an _account ID_ string (a universal Atlassian user identifier).\n * `date`, which is indexed as a date and allows date range searching and ordering. The expected date format is [YYYY]-[MM]-[DD].\n The expected date time format is [YYYY]-[MM]-[DD]T[hh]:[mm] with optional offset from UTC: +/-[hh]:[mm] or `Z` for no offset.\n For reference, please see [ISO_8601 standard](http://www.w3.org/TR/NOTE-datetime).\n\n"
}
},
"required": [
"objectName",
"type"
],
"shortClassName": "entityPropertyIndexExtractionConfigurationBean",
"type": "object",
"title": "Property Index",
"description": "\n\nDefines an entity property to be indexed by Jira. An entity property is a reference to a JSON object, which also defines it's type.\n Entity properties allow add-ons to add key/value stores to Jira entities, such as issues or projects.\n This module allows you to request those entity properties to be indexed by Jira and able to be queried via JQL searches.\n They are also available in the following conditions:\n
The purpose of this module is to specify what data from which entity properties should be extracted and indexed.\n Pretend that an add-on developer has an issue entity property with the key 'attachment' and in that entity property they store the following\n data:
\n\n\n \n {\n \"size\": 14231,\n \"name\": \"new-years-jam\",\n \"extension\": \"mp3\",\n \"updated\": \"2016-12-25T20:55:59\"\n }\n \n \n\n In this example the developer wants to make the size, extension and updated fields under the attachment key searchable via JQL. To do that they start\n by declaring that the entityType to index will be an 'issue' entity type; this is specified at the top level of their\n module. Then they need to specify which entity property key they wish to extract data from: so they add a single entry\n to keyConfiguratons with propertyKey set to 'attachment'. If there are multiple issue entity properties that an add-on developer wanted\n to index then they could add more keyConfigurations to declare those extra properties. From there the add-on developer specifies\n which data they want to extract from the json value that is stored in this issue entity property. In this example they would\n add three extractions for the size, extension and updated paths under the attachment key, being clear to specify the type\n of data being extracted and what alias should be made available to JQL queries.
\n\nIt is important to note that array types can be indexed too; the type field in the extraction should be the type of\n each element in the array.
\n\nYou can see the resultant module definition in the example below.
\n\nFor more information, please see the Jira documentation on entity properties.
\n\nThis module allows third-party providers to send feature flag information to Jira and associate it with an issue.
\nSupplied feature flag information will be presented in the right sidebar of the\n new Jira issue view under Releases.
\nThis module also provides actions, which allow users to create or link existing feature flags to Jira issues.
\n\nFeature flag information is written/deleted via REST. This API is part of the Jira Software REST documentation.
\n\nNote that the module key and name are not considered private and should therefore not contain any sensitive or personally identifiable information.
\n\nDefines the URL template that is used when an action is invoked. The following context parameters are supported: {issue.key}, {issue.summary}, {issue.deployments}.
Deployment 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", "fieldDescription": "\n\nOptional actions that can be performed by Jira users, e.g., list all deployments associated with the issue.\n\n" }, "logoUrl": { "format": "uri", "type": "string", "fieldDescription": "\n\nOptional URL to the provider's logo, which will be displayed in the UI\n\n" }, "key": { "pattern": "^[a-zA-Z0-9-]+$", "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": [ "homeUrl", "name", "key" ], "shortClassName": "deploymentInfoProviderModuleBean", "type": "object", "title": "Deployment", "description": "\n\nThis module allows third-party providers to send deployment information to Jira and associate it with an issue.
\nSupplied deployment information will be presented in the right sidebar of the\n new Jira issue view under Releases.
\nThis module also provides actions, for example, allowing users to list all existing deployments.
\n\nDeployment information is written and deleted via REST. This API is part of the Jira Software REST documentation.
\n\nNote that the module key and name are not private and therefore should not contain any sensitive or personally identifiable information.
\n\nThe \"lightest\" weight (i.e., lowest number) appears first, rising relative to other items, while the \"heaviest\"\n weights sink to the bottom of the menu or list.
\n\n", "defaultValue": "100" }, "iconUrl": { "format": "uri", "type": "string", "fieldDescription": "\n\nSpecifies an icon URL that will displayed alongside the link to the project page in the project sidebar.\n\n The icon resource provided in this field should be larger or equals to 16x16 pixels.\n If the type is 'link' then this specifies the URL template for the link.\n It is possible to use context parameters in the template.\n
\n\n\n The URL may be relative or absolute. If it is the former, then the Jira context path will be prepended automatically.\n
\n\n\n The following context parameters are available:\n
\"{\"label\": {\"color\": \"red\", \"text\":\"connect\"}} the valid path\n referencing the color is label.color.\n\n Currently, specifying of index for JSON arrays and first level JSON (such as \"true\") is not supported.\n The JSON needs to be an object with properties.\n\n"
},
"name": {
"type": "string",
"fieldDescription": "\n\nThe name, under which this property will be searchable with JQL. If not given, the pathwill be used.\n For a field with name Field Name, and an extraction with name ExtractionName the resulting query string will be\n \"Field Name\".ExtractionName.\n\n" }, "type": { "enum": [ "number", "NUMBER", "text", "TEXT", "string", "STRING", "user", "USER", "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`, which is indexed as a number and allows the range ordering and searching on this field.\n * `text`, which is tokenized before indexing and allows searching for particular words.\n * `string` which is indexed as is and allows searching for the exact phase only.\n * `user`, which is indexed as a user and allows user-based searching. The expected value is an _account ID_ string (a universal Atlassian user identifier).\n * `date`, which is indexed as a date and allows date range searching and ordering. The expected date format is [YYYY]-[MM]-[DD].\n The expected date time format is [YYYY]-[MM]-[DD]T[hh]:[mm] with optional offset from UTC: +/-[hh]:[mm] or `Z` for no offset.\n For reference, please see [ISO_8601 standard](http://www.w3.org/TR/NOTE-datetime).\n\n" } }, "required": [ "path", "type" ], "shortClassName": "issueFieldValueExtractionBean", "type": "object", "title": "Issue Field Option Property Index", "description": "\n\nDefines an issue field option property to be indexed by Jira. An option can contain an additional properties object.\n In this bean, you can define which properties will be extracted, so that a user will be able to search for issues which have options set that have a certain property.\n\n
\n Note that `multi_select` fields may have more than one option selected. In that case, properties from all options\n are indexed. Each Option's properties should have the same structure to be indexed properly, i.e. the types of values\n across all options' properties should not differ. If they do, Jira will still try to act smart and do the most reasonable thing,\n but the results are not guaranteed.\n
\n\n\n Issue field module allows the add-on to add a new field in Jira that will be visible in the issue view.\n It can be added to any screen just like any other field. It can be referenced in the REST API by $(add-on-key)__$(field-key).\n For fields of single-select type you additionally need to populate the field with the allowed values.\n See the REST API for issue field options.\n
\nBuild actions that can be performed by Jira users.
\nCurrently there are no actions defined for build providers. Please contact us if you need any.
\n\n", "fieldDescription": "\n\nOptional actions that can be performed by Jira users\n\n" }, "logoUrl": { "format": "uri", "type": "string", "fieldDescription": "\n\nOptional URL to the provider's logo, which will be displayed in the UI\n\n" }, "key": { "pattern": "^[a-zA-Z0-9-]+$", "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": [ "homeUrl", "name", "key" ], "shortClassName": "buildInfoProviderModuleBean", "type": "object", "title": "Build", "description": "\n\nThis module allows third-party providers to send build information to Jira and associate it with issues.
\nSupplied build information will be presented in the\n development panel.
\n\n
Build information is written and deleted via REST. This API is part of the Jira Software REST documentation.
\n\n
Note that the module key and name are not private and therefore should not contain any sensitive or personally identifiable information.
\n\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"
},
"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"
}
},
"shortClassName": "lifecycleBean",
"type": "object",
"title": "Lifecycle",
"description": "\n\nAllows an add-on to register callbacks for events that occur in the lifecycle of an installation. When a lifecycle\n event is fired, a POST request will be made to the appropriate URL registered for the event.\n\n The installed lifecycle callback is an integral part of the installation process\n of an add-on, whereas the remaining lifecycle events are essentially webhooks.\n\n Each property in this object is a URL relative to the add-on's base URL.\n\n | Attribute | \nDescription | \n
|---|---|
key | \n Add-on key that was installed into the Atlassian Product, as it appears in your add-on's descriptor. | \n
clientKey | \n Identifying key for the Atlassian product instance that the add-on was installed into. This will never change for a given\n instance, and is unique across all Atlassian product tenants. This value should be used to key tenant details\n in your add-on. The one time the clientKey can change is when a backup taken from a different instance is restored onto the instance.\n Determining the contract between the instance and add-on in this situation is tracked by\n AC-1528 in the Connect backlog. | \n
sharedSecret | \n Use this string to sign outgoing JWT tokens and validate incoming JWT tokens. Optional: and may not\n be present on non-JWT add-on installations, and is only sent on the installed event. | \n
serverVersion | \n This is a string representation of the host product's version. Generally you should not need it. | \n
pluginsVersion | \n This is a semver compliant version of Atlassian Connect which is running on the host server, for example: 1.1.15. | \n
baseUrl | \n URL prefix for this Atlassian product instance. All of its REST endpoints begin with this `baseUrl`. | \n
productType | \n Identifies the category of Atlassian product, e.g. jira or confluence. | \n
description | \n The host product description - this is customisable by an instance administrator. | \n
serviceEntitlementNumber\n (optional) | \n Also known as the SEN, the service entitlement number is the add-on license id. This attribute will only be included\n during installation of a paid add-on. | \n
oauthClientId | \n The OAuth 2.0 client ID for your add-on. For more information, see OAuth 2.0 - JWT Bearer token authorization grant type | \n
When this payload information is POSTed to your Atlassian Connect service you may receive the user\\_key and user\\_id\n query parameters; these query parameters are both deprecated. Deprecated\n If you wish to find out which user enabled your add-on then you should extract the context.user.userKey or context.user.userName\n data from the JWT token on the enabled lifecycle event.
See active migrations page for the list of currently active API migrations.
\n\n\n\n\n\n {\"apiMigrations\":{\"gdpr\":true}}\n\n\n\n\n For more info about this feature see API migration Opt-in documentation.\n\n", "fieldDescription": "\n\nThe flags for the apiMigrations that this addon has opted into.\n\n" }, "apiVersion": { "type": "integer", "fieldDescription": "\n\nThe API version is an OPTIONAL integer. If omitted we will infer an API version of 1.\n\n The intention behind the API version is to allow vendors the ability to beta test a major revision to their Connect add-on as a private version,\n and have a seamless transition for those beta customers (and existing customers) once the major revision is launched.\n\n Vendors can accomplish this by listing a new private version of their add-on, with a new descriptor hosted at a new URL.\n\n They use the Atlassian Marketplace's access token facilities to share this version with customers (or for internal use).\n When this version is ready to be taken live, it can be transitioned from private to public, and all customers will be seamlessly updated.\n\n It's important to note that this approach allows vendors to create new versions manually, despite the fact that in the common case, the versions are automatically created.\n This has a few benefits-- for example, it gives vendors the ability to change their descriptor URL if they need to\n (the descriptor URL will be immutable for existing versions)\n\n" }, "vendor": { "$ref": "#/definitions/vendor", "fieldDescription": "\n\nThe vendor who is offering the add-on\n\n" }, "translations": { "properties": { "paths": { "properties": { "ru-RU": { "format": "uri", "type": "string", "title": "ru-RU", "fieldDescription": "\n\nTranslations for the \"ru-RU\" (Russian) locale.\n\n" }, "de-DE": { "format": "uri", "type": "string", "title": "de-DE", "fieldDescription": "\n\nTranslations for the \"de-DE\" (German) locale.\n\n" }, "pt-PT": { "format": "uri", "type": "string", "title": "pt-PT", "fieldDescription": "\n\nTranslations for the \"pt-PT\" (Portuguese) locale.\n\n" }, "en-US": { "format": "uri", "type": "string", "title": "en-US", "fieldDescription": "\n\nTranslations for the \"en-US\" (American English) locale.\n\n" }, "ko-KR": { "format": "uri", "type": "string", "title": "ko-KR", "fieldDescription": "\n\nTranslations for the \"ko-KR\" (Korean) locale.\n\n" }, "es-ES": { "format": "uri", "type": "string", "title": "es-ES", "fieldDescription": "\n\nTranslations for the \"es-ES\" (Spanish) locale.\n\n" }, "en-UK": { "format": "uri", "type": "string", "title": "en-UK", "fieldDescription": "\n\nTranslations for the \"en-UK\" (British English) locale.\n\n" }, "fr-FR": { "format": "uri", "type": "string", "title": "fr-FR", "fieldDescription": "\n\nTranslations for the \"fr-FR\" (French) locale.\n\n" }, "ja-JP": { "format": "uri", "type": "string", "title": "ja-JP", "fieldDescription": "\n\nTranslations for the \"ja-JP\" (Japanese) locale.\n\n" } }, "additionalProperties": false, "shortClassName": "translationPathsBean", "type": "object", "title": "Translation Paths", "description": "\n\nThis object is used to specify the locations of translations files.\n It is used in the translations property of the add-on descriptor.\n\n Every property in this object is optional. The location defined in each property can be relative to the base URL of the add-on or absolute.\n\nThe add-on descriptor is a JSON file (atlassian-connect.json) that describes the add-on to the Atlassian application.\n The descriptor includes general information for the add-on, as well as the modules that the add-on wants to use or\n extend.
If you're familiar with Java add-on development with previous versions of the Atlassian Plugin Framework, you may already be\n familiar with the `atlassian-plugin.xml` descriptors. The `atlassian-connect.json` serves the same function.
\n\nThe descriptor serves as the glue between the remote add-on and the Atlassian application. When an administrator for a\n cloud instance installs an add-on, what they are really doing is installing this descriptor file, which\n contains pointers to your service. You can see an example below.
\n\nFor details and application-specific reference information on the descriptor please refer to the \"jira modules\"\n and \"confluence modules\" sections of this documentation. But we'll call out a few highlights from the example here.
\n\nSince Atlassian Connect add-ons are remote and largely independent from the Atlassian application, they can be changed\n at any time, without having to create a new version or report the change to the Atlassian instance. The changes are\n reflected in the Atlassian instance immediately (or at least at page reload time).
\n\nHowever, some add-on changes require a change to the descriptor file itself. For example, an add-on could be modified\n to have a new page module. Since this requires a page module declaration in the descriptor, it means making an updated\n descriptor available. Until that updated descriptor is re-installed into the Atlassian Product that change in the descriptor\n file will not take effect. To propagate a change in the descriptor to the Atlassian products, you need to create a new version\n of the add-on in its Marketplace listing. The Marketplace will take care of the rest: informing administrators\n and automatically installing the available update. See [Upgrades](/platform/marketplace/upgrading-and-versioning-cloud-apps/) for more details.
\n\n \n\naddon- a URL relative to the add-on's base URL
page- targets a Page module by specifying the Page's module key as the URL
product- a URL relative to the product's base URL
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:
\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\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": { "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": { "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\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" } }, "required": [ "name", "location", "key" ], "shortClassName": "webItemModuleBean", "type": "object", "title": "Web Item", "description": "\n\nAdds a web item to a specified location in the application interface. A web item is a hyperlink\n that’s inserted into some standard place in the Atlassian application interface, such as the\n administration menu.
\n\nThe form that the link takes can vary depending on the location. For instance, a web item in the header bar\n (with a location section of `system.top.navigation.bar`) adds a link to the navigation bar across the top of the\n interface. On the other hand, a web item in the `opsbar-operation` location section in Jira adds an item to the\n issue operation buttons.
\n\nA web item link can open a new page in the application or a dialog, depending on your configuration.
\n\nWeb items are a simple and useful way to extend Atlassian applications. If you want to extend an Atlassian\n application and don't know where to start, a web item may be all you need.
\n\nYour add-on can receive [additional context](../../context-parameters/) from the application by\n using variable tokens in the `url` attribute.
\n\nLocation in the application interface for this panel.
\n\n Find product locations with the Web Fragment Finder\n\n \n\n" }, "conditions": { "items": { "type": "object", "anyOf": [ { "$ref": "#/definitions/singleCondition" }, { "$ref": "#/definitions/compositeCondition" } ] }, "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\n Example\n\n\n\n\n\n {\n \"params\": {\n \"someOtherProperty\": \"someValue\",\n \"myCustomProperty\": \"myValue\"\n }\n }\n\n\n" }, "url": { "format": "uri-template", "type": "string", "fieldDescription": "\n\nThe URL of the add-on resource that provides the web panel content. This URL must be relative to the add-on's \n baseUrl and can use context parameters.\n\n" }, "key": { "pattern": "^[a-zA-Z0-9-]+$", "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": [ "name", "location", "url", "key" ], "shortClassName": "webPanelModuleBean", "type": "object", "title": "Web Panel", "description": "\n\nAdds a panel (or section) to a page in the Atlassian application. Panels let you present related information and\n controls in the application interface as a group. For example, the existing \"People\" panel in Jira issue view shows\n the assignee, reporter, and similar information for the issue.\n\natlassian-connect.json descriptor.\n\n ${project.id}, a POST message will\n be sent to the address with the ${project.id} replaced by the id of the project that the event was triggered for.\n\n jira:issue\\_createdjira:issue\\_deletedjira:issue\\_updatedcomment\\_createdcomment\\_updatedcomment\\_deletedconnect\\_addon\\_disabledconnect\\_addon\\_enabledjira:issue\\_createdjira:issue\\_deletedjira:issue\\_updated\n\n Context parameters are ${project.id}, ${project.key}, ${issue.key}, ${issue.id}.jira:version\\_createdjira:version\\_deletedjira:version\\_mergedjira:version\\_updatedjira:version\\_movedjira:version\\_releasedjira:version\\_unreleased\n\n Context parameters are ${project.id}, ${project.key}, ${version.id}.\n\n Special context parameter for version\\_merged event is ${mergedVersion.id}.project\\_createdproject\\_updatedproject\\_deleted\n\n Context parameters are ${project.id}, ${project.key}user\\_createduser\\_deleteduser\\_updated\n\n Context parameters: ${modifiedUser.accountId}, ${modifiedUser.name} (deprecated), ${modifiedUser.key} (deprecated)option\\_voting\\_changedoption\\_watching\\_changedoption\\_unassigned\\_issues\\_changedoption\\_subtasks\\_changedoption\\_attachments\\_changedoption\\_issuelinks\\_changedoption\\_timetracking\\_changedcomment\\_createdcomment\\_updatedcomment\\_deletedattachment\\_createdattachment\\_removedattachment\\_restoredattachment\\_trashedattachment\\_updatedattachment\\_viewedblog\\_createdblog\\_removedblog\\_restoredblog\\_trashedblog\\_updatedblog\\_viewedblueprint\\_page\\_createdcomment\\_createdcomment\\_removedcomment\\_updatedconnect\\_addon\\_disabledconnect\\_addon\\_enabledcontent\\_createdcontent\\_restoredcontent\\_trashedcontent\\_updatedcontent\\_permissions\\_updatedgroup\\_createdgroup\\_removedlabel\\_addedlabel\\_createdlabel\\_deletedlabel\\_removedloginlogin\\_failedlogoutpage\\_children\\_reorderedpage\\_createdpage\\_movedpage\\_removedpage\\_restoredpage\\_trashedpage\\_updatedpage\\_viewedrelation\\_createdrelation\\_deletedsearch\\_performedspace\\_createdspace\\_logo\\_updatedspace\\_permissions\\_updatedspace\\_removedspace\\_updatedtheme\\_enableduser\\_createduser\\_deactivateduser\\_followeduser\\_reactivateduser\\_removed\n POST /jira-issue\\_created?user\\_id=admin&user\\_key=admin HTTP/1.1\n Authorization: JWT ...\n Atlassian-Connect-Version: x.x\n Content-Type: application/json\n {\n timestamp: 1426661049725,\n webhookEvent: 'jira:issue\\_created',\n ...\n }\n \n {\n \"timestamp\"\n \"event\"\n \"user\": {\n // See User shape in the linked document\n },\n \"issue\": {\n // See Issue shape in the linked document\n },\n \"changelog\" : {\n // See Changelog shape in the linked document\n },\n \"comment\" : {\n // See Comment shape in in the linked document\n }\n }\n \n {\n \"page\": {\n \"spaceKey\": \"~admin\",\n \"modificationDate\": 1471926079631,\n \"creatorKey\": \"ff80808154510724015451074c160001\",\n \"creatorName\": \"admin\",\n \"lastModifierKey\": \"ff80808154510724015451074c160001\",\n \"self\": \"https://cloud-development-environment.atlassian.net/wiki/display/~admin/Some+random+test+page\",\n \"lastModifierName\": \"admin\",\n \"id\": 16777227,\n \"title\": \"Some random test page\",\n \"creationDate\": 1471926079631,\n \"version\": 1\n },\n \"user\": \"admin\",\n \"userKey\": \"ff80808154510724015451074c160001\",\n \"timestamp\": 1471926079645,\n \"username\": \"admin\"\n }\n \n {\n \"comment\": {\n \"spaceKey\": \"~admin\",\n \"parent\": {\n \"spaceKey\": \"~admin\",\n \"modificationDate\": 1471926079631,\n \"creatorKey\": \"ff80808154510724015451074c160001\",\n \"creatorName\": \"admin\",\n \"lastModifierKey\": \"ff80808154510724015451074c160001\",\n \"self\": \"https://cloud-development-environment.atlassian.net/wiki/display/~admin/Some+random+test+page\",\n \"lastModifierName\": \"admin\",\n \"id\": 16777227,\n \"title\": \"Some random test page\",\n \"creationDate\": 1471926079631,\n \"version\": 1\n },\n \"modificationDate\": 1471926091465,\n \"creatorKey\": \"ff80808154510724015451074c160001\",\n \"creatorName\": \"admin\",\n \"lastModifierKey\": \"ff80808154510724015451074c160001\",\n \"self\": \"https://cloud-development-environment/wiki/display/~admin/Some+random+test+page?focusedCommentId=16777228#comment-16777228\",\n \"lastModifierName\": \"admin\",\n \"id\": 16777228,\n \"creationDate\": 1471926091465,\n \"version\": 1\n },\n \"user\": \"admin\",\n \"userKey\": \"ff80808154510724015451074c160001\",\n \"timestamp\": 1471926091468,\n \"username\": \"admin\"\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": { "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": { "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\nDetermines the order in which the web section appears in the menu or list.
\n\nThe \"lightest\" weight (i.e., lowest number) appears first, rising relative to other items, while the \"heaviest\"\n weights sink to the bottom of the menu or list.
\n\nBuilt-in web sections have weights that are incremented by numbers that leave room for additional sections, such\n as by 10 or 100. Be mindful of the weight you choose for your item, so that it appears in a sensible order given\n existing items.
\n\n", "defaultValue": "100" }, "location": { "type": "string", "fieldDescription": "\n\nThe location in the application interface where the web section should appear. For the Atlassian application\n interface, a location is something like the coordinates on a map. It points to a particular drop-down menu or\n navigation list in the UI.\n\n Find product locations with the Web Fragment Finder\n\n \n\n" }, "conditions": { "items": { "type": "object", "anyOf": [ { "$ref": "#/definitions/compositeCondition" }, { "$ref": "#/definitions/singleCondition" } ] }, "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\n Example\n\n\n\n\n\n {\n \"params\": {\n \"someOtherProperty\": \"someValue\",\n \"myCustomProperty\": \"myValue\"\n }\n }\n\n\n" }, "key": { "pattern": "^[a-zA-Z0-9-]+$", "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": [ "name", "location", "key" ], "shortClassName": "webSectionModuleBean", "type": "object", "title": "Web Section", "description": "\n\nThe Web Section plugin module allows add-ons to define new sections in application menus. Each section can contain one or\n more links. To insert the links themselves, see the [Web Item Module](../web-item/).\n\nAn object containing options for this dialog.
\n\n" }, "url": { "format": "uri-template", "type": "string", "fieldDescription": "\n\nSpecifies the URL of the content displayed in the dialog. The URL can be absolute or relative to either the\n product URL or the add-on's base URL, depending on the _context_ attribute.\n\n Your add-on can receive additional context from the application by\n using variable tokens in the URL attribute.\n\n" }, "key": { "pattern": "^[a-zA-Z0-9-]+$", "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": [ "url", "key" ], "shortClassName": "dialogModuleBean", "type": "object", "title": "Dialog", "description": "\n\nA common dialog definition that may be referenced by other Connect modules and from JavaScript API calls.
\n\n\n For example, take the following dialog module:\n
\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\n\n\n This common dialog might be referenced from a web item target, so that\n triggering the web item launches the dialog:\n
\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\n\n The common dialog might also be referenced when creating a Dialog manually with the\n JavaScript API:\n
\n\n AP.require('dialog', function(dialog){\n dialog.create({\n key: 'dialog-module-key'\n }).on(\"close\", callbackFunc);\n });\n location property is not specified, a default location is used:\n\n Jira:\n\n generalPage: system.top.navigation.baradminPage: advanced\\_menu\\_section/advanced_sectiongeneralPage: system.help/pagesadminPage: system.admin/marketplace_confluencelocation to \"none\".\n\n"
},
"conditions": {
"items": {
"type": "object",
"anyOf": [
{
"$ref": "#/definitions/compositeCondition"
},
{
"$ref": "#/definitions/singleCondition"
}
]
},
"type": "array",
"fieldDescription": "\n\nConditions can be added to display only when all the given conditions are true.\n\nThe supported conditions for pages are:\n\nCommon conditions\n\naddon_property_existsaddon_property_equal_toaddon_property_equal_to_contextaddon_property_contains_anyaddon_property_contains_alladdon_property_contains_contextaddon_property_contains_any_user_groupuser_is_adminuser_is_logged_inuser_is_sysadminaddon_is_licensedfeature_flagentity_property_existsentity_property_equal_toentity_property_equal_to_contextentity_property_contains_anyentity_property_contains_allentity_property_contains_contextentity_property_contains_any_user_groupcan_use_applicationproject_typehas_global_permissioncontent_property_existscontent_property_equal_tocontent_property_equal_to_contextcontent_property_contains_anycontent_property_contains_allcontent_property_contains_contextcontent_property_contains_any_user_groupspace_property_existsspace_property_equal_tospace_property_equal_to_contextspace_property_contains_anyspace_property_contains_allspace_property_contains_contextspace_property_contains_any_user_groupPage modules allow add-ons to insert new pages into Atlassian products. These can be automatically resized to the width\n and height of your add-on's content. The location attribute defines where links to the new page appear.
\n\nEach type of page displays differently:
\ngeneralPages - have no extra styling and by default a link to the page is displayed in the main navigation menu.\n Use these pages in order to display general content.jiraProjectPages - (Jira only) appear in the project sidebar.\n Use these pages in order to provide project-specific content. The project page module has a separate documentation page here:\n [Project Page](https://developer.atlassian.com/cloud/jira/platform/modules/project-page/).You can also define a page module to be shown when a user is administering your add-on via the\n [Universal Plugin Manager](https://confluence.atlassian.com/x/z4Q5Eg). An add-on can only define a single page of\n this type. It should each be defined in the descriptor as a single JSON object, not as a JSON array like\n other modules.
\npostInstallPage - A \"Get Started\" button will link to this page from both the add-on's entry in Manage Add-ons\n and from the dialog that the user is shown when they successfully install the add-on. Use this page to provide introductory\n information about the add-on to the user.The content for a page module is injected into the Atlassian application in the form of a \"seamless\" iframe.\n Seamless iframes are regular HTML iframes but with the characteristics described below.
\n\nAs implied here, for most page content modules, you do not need to be concerned with iframe sizing.\n It's all handled for you. However, an exception exists for inline macros.
\ndata-options attribute \"sizeToParent:true\" in the script tag for all.js. It is also possible to hide footer for such pages.\n<script src="{{hostScriptUrl}}"\n type="text/javascript"\n data-options="sizeToParent:true;hideFooter:true">\n</script>\n location property is not specified, a default location is used:\n\n Jira:\n\n generalPage: system.top.navigation.baradminPage: advanced\\_menu\\_section/advanced_sectiongeneralPage: system.help/pagesadminPage: system.admin/marketplace_confluencelocation to \"none\".\n\n"
},
"conditions": {
"items": {
"type": "object",
"anyOf": [
{
"$ref": "#/definitions/compositeCondition"
},
{
"$ref": "#/definitions/singleCondition"
}
]
},
"type": "array",
"fieldDescription": "\n\nConditions can be added to display only when all the given conditions are true.\n\nThe supported conditions for pages are:\n\nCommon conditions\n\naddon_property_existsaddon_property_equal_toaddon_property_equal_to_contextaddon_property_contains_anyaddon_property_contains_alladdon_property_contains_contextaddon_property_contains_any_user_groupuser_is_adminuser_is_logged_inuser_is_sysadminaddon_is_licensedfeature_flagentity_property_existsentity_property_equal_toentity_property_equal_to_contextentity_property_contains_anyentity_property_contains_allentity_property_contains_contextentity_property_contains_any_user_groupcan_use_applicationproject_typehas_global_permissioncontent_property_existscontent_property_equal_tocontent_property_equal_to_contextcontent_property_contains_anycontent_property_contains_allcontent_property_contains_contextcontent_property_contains_any_user_groupspace_property_existsspace_property_equal_tospace_property_equal_to_contextspace_property_contains_anyspace_property_contains_allspace_property_contains_contextspace_property_contains_any_user_groupAdmin Pages display in the administration area. Appropriate menus and other styling appear around your content.\n Use these pages in order to provide extra administration functionality.
\n\nYou can also define admin page modules to be shown when a user is administering your add-on via the\n [Universal Plugin Manager](https://confluence.atlassian.com/x/z4Q5Eg). An add-on can only define a single page of\n each of these types. They should each be defined in the descriptor as a single JSON object, not as a JSON array like\n other modules.
\nconfigurePage - a \"Configure\" button will link to this page from the add-on's entry in Manage Add-ons.\n Use this page to provide configuration of the add-on itself.The content for an admin page module is injected into the Atlassian application in the form of a \"seamless\" iframe.\n Seamless iframes are regular HTML iframes but with the characteristics described below.
\n\nAs implied here, for most admin page content modules, you do not need to be concerned with iframe sizing.\n It's all handled for you. However, an exception exists for inline macros.
\ndata-options attribute \"sizeToParent:true\" in the script tag for all.js. It is also possible to hide footer for such pages.\n<script src="{{hostScriptUrl}}"\n type="text/javascript"\n data-options="sizeToParent:true;hideFooter:true">\n</script>\n The 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\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" }, "featureFlagProviderActionsBean": { "properties": { "linkFlag": { "properties": { "templateUrl": { "format": "uri-template", "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" }, "issueGlance": { "properties": { "icon": { "$ref": "#/definitions/icon", "fieldDescription": "\n\nSpecifies an icon to display at the left of the glance view control.\n The icon resource provided in this field should be 24x24 pixels or larger, preferably in SVG format.\n\n" }, "name": { "$ref": "#/definitions/i18nProperty", "fieldDescription": "\n\nA human readable name.\n\n" }, "conditions": { "items": { "type": "object", "anyOf": [ { "$ref": "#/definitions/singleCondition" }, { "$ref": "#/definitions/compositeCondition" } ] }, "type": "array", "fieldDescription": "\n\nConditions can be added to display only when all the given conditions are true.\n\n" }, "content": { "type": "object", "fieldDescription": "\n\nThis content becomes the label next to the icon. It's handy for communicating a small amount of information.\n\n Read about [Issue Glance Content Label](/cloud/jira/platform/modules/issue-glance-content-label/).\n\n", "anyOf": [ { "properties": { "label": { "$ref": "#/definitions/i18nProperty", "fieldDescription": "\n\n" }, "type": { "enum": [ "label", "LABEL" ], "type": "string", "fieldDescription": "\n\nThe type field must be set to 'label'\n\n" } }, "required": [ "label", "type" ], "shortClassName": "issueGlanceContentLabelBean", "type": "object", "title": "Issue Glance Content Label", "description": "\n\nDescribes the content for the issue glance module. It specifies static text to show inside the glance, which is left-aligned next to the icon.\n\n" } ] }, "key": { "pattern": "^[a-zA-Z0-9-]+$", "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" }, "target": { "type": "object", "fieldDescription": "\n\nSpecifies the target action when clicking on the glance.\n\n Read about [Issue Glance Target Web Panel](/cloud/jira/platform/modules/issue-glance-target-web-panel/).\n\n", "anyOf": [ { "properties": { "type": { "enum": [ "web_panel", "WEB_PANEL" ], "type": "string", "fieldDescription": "\n\nThe type field must be set to 'web_panel'\n\n" }, "url": { "format": "uri-template", "type": "string", "fieldDescription": "\n\nThe URL of the app resource that provides the web panel content. This URL must be relative to the app's baseUrl.\n\n" } }, "required": [ "type", "url" ], "shortClassName": "issueGlanceTargetWebPanelBean", "type": "object", "title": "Issue Glance Target Web Panel", "description": "\n\nDescribes the target of the issue glance module. This supports displaying a web panel in the context area of the issue.\n\n" } ] } }, "required": [ "icon", "name", "content", "key", "target" ], "additionalProperties": true, "shortClassName": "issueGlanceModuleBean", "type": "object", "title": "Issue Glance", "description": "\n\nThis module adds a special user interface element that appears in the right side of the new Jira issue view under the status and alongside other fields like the assignee, priority, and labels.
\nGlances provide a quick way for a user to get an overview of some information, provided by your app, that relates to an issue.
\nThe Glance object (which includes your icon, content and URL) is defined using the Issue Glance module.
\n\nThe status of a Glance for a specific an issue can be set using the Set issue property API.
\nThe issue property key needs to be formatted as com.atlassian.jira.issue:[addonKey]:[moduleKey]:status to set the status.
The JSON in your PUT request to set the status should follow this format depending on the type of status you wish you display:
\n{ type: 'lozenge', value: { label: 'Hello', type: 'default' } }. For available lozenge types, refer to lozenge appearance.{ type: 'icon', value: { label: '/img/tick.png' } }. Note that label is the URL relative to your app's base URL.{ type: 'badge', value: { label: '123' } }. Note that label must be a numeric string.More recommended usage and user experience suggestions are available in the design guidelines.
\n\nISSUE\\_GLANCE\\_OPENED eventWhen a user clicks a glance, the glance panel slides in and covers the details on the right side of the issue. The ISSUE\\_GLANCE\\_OPENED event is sent. which you can listen for using the JavaScript API. See the example provided below.
AP.events.on('ISSUE\\_GLANCE\\_OPENED', function() {\n // You can decide the logic here in add-on.\n });You can use this to load additional web resource or trigger activity in your add-on.
\nMore recommended usage and user experience suggestions are available in the design guidelines.
\n\n" }, "issueContent": { "properties": { "icon": { "$ref": "#/definitions/icon", "fieldDescription": "\n\nSpecifies an icon to show alongside the quick-add menu item.\n The icon should be 24x24 pixels or larger, preferably in .SVG format.\n\n" }, "tooltip": { "$ref": "#/definitions/i18nProperty", "fieldDescription": "\n\nSpecifies a tooltip for the quick-add menu item.\n\n" }, "name": { "$ref": "#/definitions/i18nProperty", "fieldDescription": "\n\nA human readable name.\n\n" }, "conditions": { "items": { "type": "object", "anyOf": [ { "$ref": "#/definitions/singleCondition" }, { "$ref": "#/definitions/compositeCondition" } ] }, "type": "array", "fieldDescription": "\n\nConditions can be added to display only when all the given conditions are true.\n\n" }, "key": { "pattern": "^[a-zA-Z0-9-]+$", "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" }, "target": { "type": "object", "fieldDescription": "\n\nSpecifies the target of this content as a result of clicking on the menu item. Currently,\n you can only display a web panel in the issue's content area.\n\n Read about [Issue Page Target Web Panel](/cloud/jira/platform/modules/issue-page-target-web-panel/).\n\n", "anyOf": [ { "properties": { "type": { "enum": [ "web_panel", "WEB_PANEL" ], "type": "string", "fieldDescription": "\n\nThe type field must be set to 'web_panel'\n\n" }, "url": { "format": "uri-template", "type": "string", "fieldDescription": "\n\nThe URL of the add-on resource that provides the web panel content.\n This URL must be relative to the app's baseUrl.\n\n" } }, "required": [ "type", "url" ], "shortClassName": "issuePageTargetWebPanelBean", "type": "object", "title": "Issue Page Target Web Panel", "description": "\n\nDescribes the target of the issue content module. Supports displaying a web panel in the content area of the issue view.\n\n" } ] }, "contentPresentConditions": { "items": { "type": "object", "anyOf": [ { "$ref": "#/definitions/singleCondition" }, { "$ref": "#/definitions/compositeCondition" } ] }, "type": "array", "fieldDescription": "\n\nSpecifies a list of [Conditions](/cloud/jira/platform/conditions/) that, when resolved to true, will\n force the content to always be displayed for that issue. Users have the ability to collapse the content\n if they don't want to see it.\n\n" } }, "required": [ "icon", "tooltip", "name", "key", "target" ], "additionalProperties": true, "shortClassName": "issueContentModuleBean", "type": "object", "title": "Issue Content", "description": "\n\nThis module adds a quick-add button alongside the existing quick-add buttons for attachments, subtasks, and linked issues in the new Jira issue view. Users will use your quick-add button to add content to help describe, and ultimately resolve, an issue.
\nWhen a user clicks on your app's quick-add button, a panel is added below the issue description that displays content from a URL provided by your app (similar to the web panel module). This URL must be a relative URL from your app's server.
\n\nISSUE\\_QUICK\\_ADD\\_CLICKED eventWhen a user clicks your quick-add button, the ISSUE\\_QUICK\\_ADD\\_CLICKED event is sent. You can listen for this event using the JavaScript API. Here's an example:
AP.events.on('ISSUE\\_QUICK\\_ADD\\_CLICKED', function(event){\n // display a dialog when quick add button was clicked. event = { isNewToIssue: boolean }\n // isNewToIssue is true if this is first time content panel being added to current issue.\n // isNewToIssue is false if content panel is already on issue view, and it is selected.\n AP.dialog.create({\n key: 'sized-panel',\n width: '500px',\n height: '200px',\n chrome: true,\n header: JSON.stringify(event)\n });\n });You can use this to design an experience where you want a user to input, select, or review information before interacting with your web panel.
\nFind out more about recommended usage and get user experience suggestions in the design guidelines.
\n\n" }, "projectAdminTabPanel": { "properties": { "name": { "$ref": "#/definitions/i18nProperty", "fieldDescription": "\n\nA human readable name.\n\n" }, "weight": { "type": "integer", "fieldDescription": "\n\nDetermines the order in which the tab panel's link appears in the menu or list.
\n\nThe \"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\nBuilt-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" }, "location": { "type": "string", "fieldDescription": "\n\nThe name of the group of tabs in the project configuration where the tab panel should appear.\n The following are accepted values.\n\n * `projectgroup1`\n * `projectgroup2`\n * `projectgroup3`\n * `projectgroup4`\n\nSee [Project Configuration Locations](https://developer.atlassian.com/jiradev/jira-architecture/web-fragments/project-configuration-locations#ProjectConfigurationLocations-AddingNewItemstoExistingWebSections) for details.\n\n" }, "conditions": { "items": { "type": "object", "anyOf": [ { "$ref": "#/definitions/compositeCondition" }, { "$ref": "#/definitions/singleCondition" } ] }, "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\n Example\n\n\n\n\n\n {\n \"params\": {\n \"someOtherProperty\": \"someValue\",\n \"myCustomProperty\": \"myValue\"\n }\n }\n\n\n" }, "url": { "format": "uri-template", "type": "string", "fieldDescription": "\n\nSpecifies the URL targeted by the tab panel. The URL is relative to the add-on's base URL.\n\n" }, "key": { "pattern": "^[a-zA-Z0-9-]+$", "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": [ "name", "url", "key" ], "shortClassName": "connectProjectAdminTabPanelModuleBean", "type": "object", "title": "Project Admin Tab Panel", "description": "\n\nProject administration tab panel modules add a new tab and corresponding page to the left hand menu on the Jira\n project settings (previously called project administration) page.\n\n\n This expression can be overridden using the configuration page.\n If you return configuration with property \"expression\", then that expression will be used\n to evaluate the validator instead of the expression defined here. For example:\n\n
AP.require([\"jira\"], function(jira) {\n jira.WorkflowConfiguration.onSave(function() {\n var config = {\n \"expression\": \"dynamically built expression\"\n };\n return JSON.stringify(config);\n });\n});\n This can be either a static [i18n property](../i18n-property/), or an object containing the \"expression\" property,\n with a Jira expression that returns the error message dynamically, based on the current transition or configuration.\n\n", "anyOf": [ { "properties": { "value": { "type": "string", "fieldDescription": "\n\nThe human-readable default value. This will be used if no translation exists.\n\n" }, "i18n": { "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": "validatorI18nErrorMessage", "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
\n Validators check that any input made to the transition is valid before the transition is performed.\n Input can include that gathered from the user on the transition's screen. If a validator fails,\n the issue does not progress to the destination status of the transition, the transition's post functions are not executed\n and the error message of the failed validator is shown.\n
\n Validators added by apps are implemented with [Jira expressions](../../jira-expressions)\n that are provided upfront in the descriptor or built dynamically on the configuration page.\n
\n A workflow validator only evaluates to true if the provided Jira expression evaluates to true. It will evaluate to false in all other cases, including:\n
AP.require([\"jira\"], function(jira) {\n jira.WorkflowConfiguration.onSave(function() {\n var config = {\n \"expression\": \"dynamically built expression\"\n };\n return JSON.stringify(config);\n });\n});\n\n This expression can be overridden using the configuration page.\n If you return configuration with property \"expression\", then that expression will be used\n to evaluate the condition instead of the expression defined here. For example:\n\n
AP.require([\"jira\"], function(jira) {\n jira.WorkflowConfiguration.onSave(function() {\n var config = {\n \"expression\": \"dynamically built expression\"\n };\n return JSON.stringify(config);\n });\n});\n Conditions control whether the user can execute a transition.\n If a condition fails, the user won't be able to execute the transition.\n For example, the user won't see the transition button on the View issue page.\n
\n Conditions added by apps are implemented with [Jira expressions](../../jira-expressions)\n that are provided upfront in the descriptor or built dynamically on the configuration page.\n
\n A workflow condition only evaluates to true if the provided Jira expression evaluates to true. It will evaluate to false in all other cases, including:\n
AP.require([\"jira\"], function(jira) {\n jira.WorkflowConfiguration.onSave(function() {\n var config = {\n \"expression\": \"dynamically built expression\"\n };\n return JSON.stringify(config);\n });\n});\nDetermines the order in which the tab panel's link appears in the menu or list.
\n\nThe \"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\nBuilt-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" }, "conditions": { "items": { "type": "object", "anyOf": [ { "properties": { "condition": { "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\n Example\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\nissues: A comma-separated list of issue keyslink: A link back to the Jira Issue Navigator where the action was invokedstartIssue: The index of the first passed issue key in the list of all issuesendIssue: The index of the last passed issue key in the list of all issuestotalIssues: The number of issues in the entire search result