Bugzilla 5.0 Changes

Upstream changes

Red Hat changes

Introduction

Bugzilla 5 introduces several changes for RPC, including a REST endpoint and API Tokens. This document is a brief summary. For full changes please see the release notes.

No immediate changes are required, but please note that the existing login method and RPC endpoints are deprecated.
The Bugzilla team recommends upgrading your scripts to ensure a smooth transition when these features are removed.

Upstream Changes

The REST Interface

Bugzilla 5.0 introduces a new REST endpoint to replace XML-RPC and JSON-RPC

Full documentation for the REST interface can be found here.

The current XML and JSON RPC endpoints are deprecated in favor of REST, and are slated to be removed from Bugzilla 7. Please consider updating your scripts to use the REST endpoint.

RPC Authentication

Bugzilla 5 introduces API keys as a new authentication mechanism. To create an API key, simply visit your preferences page and click on the 'API Key' tab.

The current method of logging in using passwords is deprecated, and will be removed in a future release.

Please see the full documentation for usage instructions.

Examples

Instead of logging in, you would just use your pre-generated API key with each request.

For a HTTP GET request you would append it to the URL like so:

https://bugzilla.redhat.com/rest/bug/bug_id?api_key=ABC123

For other requests, such as a bug update you embed it in the JSON body with the other RPC parameters


PUT /rest/bug/bug_id
{
    "status": "CLOSED",
    "resolution": "CURRENTRELEASE",
    "api_key": "abc123"
}

API Changes

There has been some minor API changes in Bugzilla 5.0

New Methods

Removed Methods

These methods were deprecated in Bugzilla 4 and have been removed from Bugzilla 5.

Red Hat Changes

Code Base Refactor

Red Hat Bugzilla has been carrying code deprecated upstream from Bugzilla 2 & 3. As part of the Bugzilla 5 merge we have removed a significant amount of this old code; paying down a significant technical debt and allowing us to become more agile at integrating upstream changes and adding custom extensions.

User Interface Refactor

The Bugzilla UI has been overhauled using SelectizeJS and DataTables.

This allows us to speed up page load times by performing expensive data lookups only when required.

Email In

Bugs can now be created and updated by email. Full bug editing and commenting is available.

For this feature to work your emails must be cryptographically signed, with a signature that Bugzilla recognizes

See the email in docs for instructions on how to set up a crypto key, and the email format required for creating and updating bugs.

SAML Authentication

Red Hat Bugzilla now allows users to log in using SAML authentication.

If your email address in Bugzilla is known to one of the following identity providers, you may log in with SAML

Improved Bulk Updates

Large bulk update operations no longer time out.

Multiple Components & Versions deprecated

The "Multiple Components & Versions" extension has been deprecated. Existing products that already use this extension may continue to use it until EOL. No new products will be allowed to use it.

In the future this extension will be removed completely.

Bayoteers Extensions

Red Hat Bugzilla now incorporates some of the Bayoteers extensions. This enables features such as:

Dependent Products

The layered products custom field has been replaced by the Dependent Products extension. This allows simpler and more accurate editing and control of the values within the field, as well as who receives notifications.

Documentation for this feature is available here

Enforcement of group policies

Red Hat Bugzilla has had policies restricting group membership and group relationships for a long time. It was left to site administrators to know and enforce these policies. As part of Bugzilla 5 we have encoded these policies and the system will now enforce them.

Product Dashboards

We have added the BMO Product Dashboard to the "My Links" menu, allowing users to see overviews of product data and performance. You can see the Red Hat Bugzilla project's status here

Update Patch Viewer

The old PatchViewer has been replaced with the much more modern diff2html diff viewer