Project Page

This module represents a page with a project sidebar.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "modules": {
    "jiraProjectPages": [
      {
        "url": "/iframe-content-url?projectId=${project.id}",
        "iconUrl": "/logo-url-or-inline-svg",
        "weight": 100,
        "name": {
          "value": "My Project Page"
        },
        "key": "my-project-page"
      }
    ]
  }
}

Properties

key

Type
string
Max length
100
Required
Yes
Pattern
^[a-zA-Z0-9-]+$

name

Type
object
Required
Yes

url

Type
string
Format
uri-template
Required
Yes
Description

Specifies the URL targeted by the page. The URL is relative to the add-on's base URL.

conditions

Type
[compositeConditionBean,singleConditionBean, ... ]

iconUrl

Type
string
Format
uri
Description

Specifies an icon URL that will displayed alongside the link to the project page in the project sidebar.

The icon resource provided in this field should be larger or equals to 16x16 pixels.

weight

Type
integer
Defaults to
100
Description

Specifies the ordering of the link in the project sidebar.

The "lightest" weight (i.e., lowest number) appears first, rising relative to other items, while the "heaviest" weights sink to the bottom of the menu or list.