Last updated Nov 24, 2022

Rate this page:

Changelog

This page includes release notes and updates for Jira Cloud app developers. Use this page to keep track of upcoming changes, deprecation notices, new features, and feature updates from Jira Cloud Platform.

Forge changelog

For updates about changes to the Forge platform, see the Forge changelog in the Forge documentation.

Go to our developer community to ask questions. You may also be interested in the What's New blog for Atlassian Cloud where details of major changes that affect all users of the Jira Cloud products are announced.

24 November 2022

Removed Cloud Fortified: Removal of StatusPage metrics UI

StatusPage has been replaced by Developer Console as the metrics UI for Cloud Fortified apps. The StatusPage metrics UI was deprecated on October 24, 2022.

Fixed Workflow rule IDs will be changed when copying workflows

Starting 2 Jan 2022, we will release a fix for ACJIRA-2584 and JRACLOUD-72099. Workflow rule IDs will be changed when copying workflows instead of being duplicated.

23 November 2022

Added UI modifications now support new custom fields

UI modifications, which is a Forge module that allows apps to modify fields on the Global issue create modal, now support the following custom fields:

  • user picker

  • multiple user picker

  • multiple select

  • textfield

For more information, see the list of supported fields.

Added Germany region added for Connect data residency

Added Germany as supported realm for Connect data residency.

Read the documentation

22 November 2022

Announcement Data residency realm migration for Connect apps: Early Access Program

Today, we are happy to announce the launch of the Early Access Program (EAP) of data residency realm migration for Connect apps. This EAP release includes a new realm migration service and associated APIs, which will enable you to start integration and testing to support migration of app data to match the parent product realm.

Read the full blog announcement here.

11 November 2022

Announcement Single value metrics in developer console

To quickly identify the current state of your Forge apps, the developer console now displays values, as well as charts, for each metric. For more information, see View app metrics.

8 November 2022

Added UI modifications now support new custom fields

UI modifications, which is a Forge module that allows apps to modify fields on the Global issue create modal, now support two custom fields:

  • single select

  • paragraph

For more information, see the list of supported fields.

7 November 2022

Announcement Get comments and worklogs operations limited to 5000 items per call

Three months ago, we announced that a limit of 5000 items per call would be applied to get comments and worklogs operations. This limit is to mitigate potential issues if a call returns large numbers of comments or worklogs. As the deprecation period has elapsed, we will publish this limit on Nov 8, 2022.

More details

Note that “items" here refers to comments or worklogs.

What is changing?

Instead of returning all items from GET rest/api/{v:2|3|latest}/issue/{issueIdOrKey}/item, we are limiting the number of items returned to 5000 per call. Clients can get all the items using pagination.

The default value for the maximum number of items returned (maxResults) is now 5000. The order and shape in which the items are returned are unaltered.

Example

This request does not specify the maxResults request parameter:

1 2 3 4 5 // Request without specifying maxResults curl --request GET \ --url 'https://<jiraBaseUrl>/rest/api/2/issue/{issueIdOrKey}/item' \ --user 'username@atlassian.com:<token>' \ --header 'Accept: application/json'

Before the change, maxResults was set to the default value of 1048576 and generated a response like this:

1 2 3 4 5 6 7 // Before the change { "startAt":?, "maxResults":1048576, // default value if not specified "total":?, // the total number of items on the issue "items":[?] }

After this change, maxResults is set to 5000 and generates a response like this:

1 2 3 4 5 6 7 // After the change { "startAt":?, "maxResults":5000, // default value if not specified "total":?, // the total number of items on the issue "items":[?] }

This request specifies the maxResults request parameter as less than 5000:

1 2 3 4 5 //request specifying maxResults to a number less than 5000 curl --request GET \ --url 'https://<jiraBaseUrl>/rest/api/2/issue/{issueIdOrKey}/item?maxResults=100' \ --user 'username@atlassian.com:<token>' \ --header 'Accept: application/json'

The response (before and after this change) is as follows:

1 2 3 4 5 6 { "startAt":?, "maxResults":100, "total":?, // the total number of items on the issue "items":[?] }

 This request specifies the maxResults request parameter as more than 5000:

1 2 3 4 5 //request specifying maxResults to a number greater than 5000 curl --request GET \ --url 'https://<jiraBaseUrl>/rest/api/2/issue/{issueIdOrKey}/item?maxResults=7500' \ --user 'username@atlassian.com:<token>' \ --header 'Accept: application/json'

The response after this change truncates the response to 5000 items like this:

1 2 3 4 5 6 { "startAt":?, "maxResults":5000, // maxResults truncated from the requested 7500 down to 5000 "total":?, // the total number of items on the issue "items":[?] // the list of items returned will be truncated to 5000 items. }

 Why are we making this change?

Most issues contain less than 5000 comment or worklog items. However, there are some issues with large numbers of items. The backing system can overload when a client queries all those issue items through rest/api/{v:2|3|latest}/issue/{issueIdOrKey}/item.

What do you need to do?

If you are not working with items returned using GET rest/api/{v:2|3|latest}/issue/{issueIdOrKey}/items, no changes to your client code are needed.

If your client only needs to know about the total of the items on an issue, you can use total from the response, and no changes to your client code are necessary.

If you are confident that your client code does not set maxResults to greater than 5000 and you do not have issues with more than 5000 items, no changes are necessary.

If your client code sets maxResults to greater than 5000 and you have issues containing more than 5000 items, you may need to modify your code to make additional calls to get more items. However. as this is a paginated operation, clients that follow pagination best practices should need no changes. 

2 November 2022

Deprecation Notice Obsolete Jira download attachment and thumbnail URLs removed in three months

In three months, legacy Jira download attachment and thumbnail APIs will be removed and replaced by supported REST APIs.

To maintain the same functionality and have OAuth scope and documentation support, you’ll have to migrate to the corresponding APIs.

More details

This change is related to https://community.developer.atlassian.com/t/updated-uris-for-avatars-attachments-and-attachment-thumbnails/53483.

The migration details are:

Functionality

Deprecated Endpoints

New Endpoint

Get attachment content - Jira

/secure/attachment/{attachmentId}/{attachmentName}

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-attachments/#api-rest-api-3-attachment-content-id-get

/rest/api/{v:2|3|latest}/attachment/content/{attachmentId}

Get attachment content - JSM

/servicedesk/customershim/secure/attachment/{attachmentId}/{attachmentName}

https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request/#api-rest-servicedeskapi-request-issueidorkey-attachment-attachmentid-get

/rest/servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId}

Get thumbnail content - Jira

/secure/thumbnail/{thumbnailId}/{thumbnailName}

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-attachments/#api-rest-api-3-attachment-thumbnail-id-get

/rest/api/{v:2|3|latest}/attachment/thumbnail/{thumbnailId}

Get thumbnail content - JSM

/servicedesk/customershim/secure/thumbnail/{thumbnailId}/{thumbnailName}

https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request/#api-rest-servicedeskapi-request-issueidorkey-attachment-attachmentid-thumbnail-get

/rest/servicedeskapi/request/{issueIdOrKey}/attachment/{thumbnailId}/thumbnail

Announcement Grouping metrics by app version in developer console

To help you debug your Forge apps, the developer console now lets you group your metrics by app version. Each chart now has a Group by dropdown menu, with the option to select Version. For more information, see Monitor your apps.

1 November 2022

Deprecation Notice Instead of relying on special default names, use Bulk Get groups API to fetch groups having certain permissions/ access

From April 30th, 2023, if your apps use hardcoded references to group names, they may stop working for customers with a new userbase configuration.

This includes references such as:

  • site-admins

  • jira-admins-<tenantName>

You can avoid this by switching to the newly added query parameter accessType in the bulk get groups GET /rest/api/3/group/bulk) API.

The API will get groups with a specific type of permission based on the accessType provided.

More details

After April 30th, 2023, we’ll start moving customers' site-level userbases to the organisation level.

If you’re developing an app, this will require you to stop using hardcoded references of special group names. Instead, utilise the API recommended above to dynamically fetch the same information.

This API will ensure the app continues to work for all customers, even after the userbase configuration changes.

Endpoint: GET /rest/api/3/group/bulk

Query parameter: accessType

Values: site-admin, admin, user.

Returns: name (name of the group) and groupId (group identifier)

31 October 2022

Announcement New Marketplace Security Requirements Are Now in Effect

Several months ago, we announced new security requirements for cloud apps, which take effect today (October 31). As of today, all Marketplace apps and Trello Apps (Power-Ups) are expected to meet the new requirements.

Maintaining a secure Marketplace is a collective effort, shared by Atlassian and partners. The new requirements reflect the most current best practices for building secure apps and provide platform-specific guidance. They set Atlassian’s baseline standard for cloud app security, and will be updated annually to ensure alignment with industry standards.

The new requirements apply across five categories: Authentication & Authorization, Data Protection, Application Security, Privacy, and Vulnerability Management. They benefit both developers and customers by providing guidelines for building secure apps and elevating the trust posture of our cloud ecosystem.

Read the blog to find out more about the changes that take effect today, and how we will validate that apps are following security requirements moving forward.

Read the blog

25 October 2022

Added New Jira Forge extension - jira:issueViewBackgroundScript

We’ve introduced the jira:issueViewBackgroundScript Forge module. This module lets you run code without adding any UI elements on the issue view page.

For more details, check out the Jira issue view background script.

24 October 2022

Removed Cloud Fortified: Removal of metrics from the program

The following Connect metrics have been removed from the Cloud Fortified program:

  • Iframe load success rate

  • Iframe load success rate from app server

  • Synthetic check success rate from app server

Deprecation Notice Cloud Fortified: Deprecation of Metrics publish API

The Metrics publish API for Cloud Fortified will be removed after Apr 24, 2023.

Metrics being sent to the API have been removed from the program.