Bug Fix Management

Bugs are an inevitable part of software development. Accordingly, so are defects within live software.

Xapi provides an API bug fixer branch which is a development branch, that is created to fix bugs or issues in an API. The API bug fixer branch is created from the main API branch and used to isolate the code changes needed to fix the API issues.

The API bug fixer branch allows developers to work on the bug fixes without affecting the main API branch. Once the bug fixes are complete, the API bug fixer branch is merged back into the main API branch, ensuring that the bug fixes are incorporated to it.

When a bug is detected, it should be assigned to be resolved and merged with the main branch. Xapi provides the below features to successfully manage bug fixing.

• Create bug fixer
• Search bug fixer
• View bug fixer
• Assign bug fixer
• Unassign bug fixer
• Status update/merge bug fixer
• Edit bug fixer
• Delete bug fixer

Create bug fixer

A platform user can add API bug fixers to their own, member, or assigned API’s. It should be an approved API. This option is available only for the Premium Organization category.

Creating an API improvement is a creation of a new API as an improvement of an existing API when the existing API is in the done state.

Follow the below instructions to create an API improvement using the basic flow:

1. Sign in to Xapi.

2. Choose the Organization from the right-upper menu. Then the Organization dashboard appears.

3. Select the Projects drop down and choose View all projects. All Projects appears.

4. Choose a Project, then the Project dashboard appears.

5. Select API catalog from right navigation pane, or select API catalog from Upper navigation bar and choose the relevant API catalog. The API catalog appears.

6. Choose the API collection, API, or API model from the catalog.

7. Select the API which is in done state.

8. Click on the three dots menu, and click Create Bug.

9. Enter API Bug details with following information.

10. Click Create to create the API Bug.

A success message is displayed and navigated to the Editor screen. After submitting successfully, the system should create a new branch to the selected parent API. Which is a bug fix branch.

Search bug fixer

A platform user can search API bug fixers that are own, member, or assigned API’s. To search, Type desired API bug fixer name in search fields either in API catalog or all search (fixed search icon).

• If API catalog search field is used, select bug fix from the sorting option.
• If all search is used, Use sorting for shortlisting.

bug fixes display the bug icon in the search results.

• then API bugs that match the searched name will display.

View bug fixer

A platform user can view all the API bugs created under the selected API. To view Log in to Xapi,

• View organization > View desired API catalog or
• Search for the desired API

Then select API and Click on ‘View bugs’ in the three dots menu of the preferred API.

Now you can;

• View all the API bug fixers of APIs that are created under the corresponding API.
• Search API bug fixers based on its name and description.
• Select each bug fixers and open it from API editor.
• Access the form view of the corresponding API-bug version.
• Edit API bug fixers details.
• Delete API bug fixers.

If the project of the corresponding API has enabled the Kanban board, Clickable-linked-ticket to the bug fixer from the Kanban board can be used to view.

Assign bug fixer

A platform user can assign an API bug to a user through the Assignee field of the API bug fixer.

1. Open the preferred editor of the API bug

2. Click on the ‘Assignee’ button

3. select a member from the existing members to assign as the bug fixer (Or you can search the member and click the name to assign)

If the project of the corresponding API has enabled the Kanban board, ‘Assignee’ button can be used in the preferred bug fixer ticket.

After assigning the member gets notified and the activity stream gets updated.

Unassign bug fixer

A platform user can unassign an API bug from user. through the Assignee field of the API bug fixer.

1. Open the preferred editor of the API bug

2. Click the Assignee drop down and choose Unassign.

If the project of the corresponding API has enabled the Kanban board, choosing unassign in the Assignee field in the preferred bug fixer ticket unassigns.

After unassigning, the assignee field value changes to 'Unassigned'.

Status update/merge bug fixer

A platform user can update the status of the bug fixer and merge the bug fixer to the base API based on the user role.

Status update of bug fixer

API bug status update permission is based on user role and the existing status of the API bug.

Designers are only allowed to update status between followings:

• To-Do --> Design-In-Progress
• Design-In-Progress to --> To-Do
• Design-In-Progress --> Review-In-Progress

Reviewers, Organization owners and Organization admins are allowed to update status between followings:

• To-Do --> Design-In-Progress
• Design-In-Progress to --> To-Do
• Design-In-Progress --> Review-In-Progress
• Review-In-Progress --> Design-In-Progress
• Review-In-Progress --> Done
• Done --> To-Do

If you have enabled the project Kanban board, follow the below instructions.

1. To view the project catalog, click on Projects drop down, and select View all projects. All the projects which you are member, designer, owner, or reviewer appears.

2. Select the Project which is your Bug API created. The project dashboard appears.

3. Select Kanban from the left navigation bar. The project Kanban board appears.

4. Select the related Kanban ticket to the Bug. The Kanban ticket appears. Click on status drop down and select following options from the current status according the permitted project user type. A successful message appears.

   Status updates accordingly in the ticket and the API Bug.

   If you have not enabled the project Kanban board follow the instructions as below.

5. Click on the API Bug. The API Bug editor appears.

6. Click on the status drop down and select following API status which is based on the current status. Now, the API Bug status is changed successfully.

Merge Bug Fixer

To merge the API bug to base API

1. Update its status from Review-In-Progress to Done status.

2. Click to the confirmation message.

3. Merge If there are conflicts resolve them.

Edit bug fixer

A platform user can edit API bug. To edit the API bug,

1. Click on three dots menu and select View Bugs from the Project API catalog. The bugs of the API appears.

2. Click on three dots menu and select Edit Bug from the API improvement.

3. Edit API improvement information.

   When you are changing status to done state your API Bug asks you to give permission to merge the API.

   If you want to merge the API, click Yes, Merge, or else click on No, Cancel.

   If click Yes, Merge, the API editor with updated status appears. API Bug Name: Existing name of your bug will be the default name. You can change the API bug name. Other fields are fixed.

4. click Save changes.

Delete bug fixer

A platform user can delete an API bug. API bug delete permission is based on the project member’s user role and the API Bug's status.

To delete the API bug,

1. Click Delete Bug of the desired API bug fixer

2. Click Delete

3. Confirm the deletion