Improvements

A development branch designated to focus on upgrading an API is known as an API improvement branch. The objective is to improve the functionality, performance, dependability, or usability of the API while avoiding the introduction of new defects or breaking current features.

It is advisable to read more information Click here.

To Create an API Improvement

To create an API Improvement, the base API should be in the Done State.

1. Click the profile icon and select All organizations. The system displays all the organizations which you have already joined.

2. Select the Organization that you desire to create the API improvement. The Organization dashboard displays.

If the selected organization has enabled the project-level API catalog,

• Click Projects drop down from the charms bar and select View all projects. The system displays all the projects which are under the organization.
• Select the project that you desire to create the API improvement. The Project dashboard displays. If the selected organization has enabled or has not enabled the project-level API catalog,
• Click the API catalogs drop-down from the charms bar and select the relevant API catalog that you desire to create the improvement.
• The API catalog screen displays.

3. Select the API that you desire to create the API improvement. The API Versions screen displays.

4. Click the horizontal ellipsis of the API which is in Done State.

5. Select Create horizontal drop down, and select Create Improvements. The Create New Improvement form displays.

6. In the resulting window, fill in the following fields as required.

7. Click Next. You are navigated to the Avatar tab.

8. Select an Avatar and color from the given options. If you want to set an image as the avatar, drop or browse an image from the system files.

9. Click Next. You are navigated to the Review tab. Review the entered details for the Create New Improvement form.

10. Click Create. The API improvement is created successfully.

To View Improvements

1. Click the profile icon and select All Organizations. The system displays all the organizations which you have already joined.

2. Select the Organization that you desire to view the API improvement. The Organization dashboard displays.

If the selected organization has enabled the project-level API catalog,

• Click Projects drop down from the charms bar and select View all projects.
  The system displays all the projects which are under the organization.
• Select the project that you desire to create the API improvement.
  The Project dashboard displays. If the selected organization has enabled or has not enabled the project-level API catalog,
• Click the API catalogs drop down from the charms bar and select the relevant API catalog that you desire to view the improvement. The API catalog screen displays.
• Select the API that you desire to view the API improvement.

The API versions screen displays.

3. Click the horizontal ellipsis of the API which is in ‘Done’ State.

4. Select View horizontal drop down and select View Improvements. The All Improvement appears.

The API editor of the API improvement appears. For more information, see API Editor.

To View Improvements

1. Click the profile icon and select All Organizations.
   The system displays all the organizations which you have already joined.

2. Select the Organization that you desire to view the API improvement. The Organization dashboard displays.

If the selected organization has enabled the project-level API catalog,

• Click Projects drop down from the charms bar and select View all projects.
  The system displays all the projects which are under the organization.
• Select the project that you desire to create the API improvement.
  The Project dashboard displays. If the selected organization has enabled or has not enabled the project-level API catalog,
• Click the API catalogs drop down from the charms bar and select the relevant API catalog that you desire to view the improvement. The API catalog screen displays.
• Select the API that you desire to view the API improvement.

The API versions screen displays.

3. Click the horizontal ellipsis of the API which is in ‘Done’ State.

4. Select View horizontal drop down and select View Improvements. The All Improvement appears.

The API editor of the API improvement appears. For more information, see API Editor.

Assign/Unassign Improvement

You can assign an API improvement to a project member so that they can continue the improved API design.

To assign/unassign improvements when the project has Kanban-enabled,

1. Navigate to Organization dashboard > API catalogs.

2. Select the relevant API catalog. The API catalog screen appears.

3. Select Kanban from the left-side panel.

4. Select the relevant Kanban ticket which is attached to the API improvement.

5. Click the Kanban ticket.

6. Select the Assignee drop-down and select the API member that you want to assign. You can unassign an improvement from the Kanban board by selecting Unassign. If the Kanban-ticket has already assigned to an API member.

You can assign the Kanban ticket to each member type according to the following status:

To assign/unassign improvements when the project has not enabled the Kanban board, To assign an API member to an API first you need to view the API improvement. See the View API improvements section for directions. Select the Assignee drop dropdown and choose an assignee. You can unassign an improvement from the API improvement by selecting Unassign from the Assignee drop down if the Kanban-ticket has already assigned to an API member.

The newly assigned API member notifies via notifications.

Change Kanban Ticket Status and Merge

You can change the status of an API improvement so that you can easily identify the state of your API. Users are encouraged to enable the Kanban board when working with projects.

follow the below instructions:

1. Navigate to Organization dashboard > API catalogs.

2. Select the relevant API catalog. The API catalog screen appears.

3. Select Kanban from the left-side panel.

4. Select the relevant Kanban ticket which is attached to the API improvement.

5. Click the Kanban ticket.

6. Click on the Status drop-down and select the following options from the current status according to the permitted project user type:

The following table explains how the status-changing permission varies based on ticket status and user roles:

Now the status of the Kanban ticket and the API improvement editor updated accordingly.

To change the status of an API improvement first you need to view the API improvement. See the View API improvements section for directions.

Click on the Status drop-down and select the following API status which is based on the current status.

See the status changing permission table for learn about the permissions:

Now, the status of the API improvement is changed successfully in the editor

After updating the API improvement status to ‘Done’ state from ‘Review-in-progress' state Xapi enables you to merge the API improvement to the base API. Follow these steps to merge the API feature to the base API:

1. Click the **Merge button and the Merge all Changes pop-up appears.

2. Fill in the following fields to proceed with the merging process.

• Merge title * - Title of the merge
• Merge message

3. Click Merge.

Now you have successfully merged the API improvement to the base API.

To Edit Improvements

You can edit the details of an existing API improvement

To edit an API improvement, you must view the API improvements first. For more information, see View Improvements.

In the resulting screen,

1. Click the vertical ellipsis on the selected API improvement.

2. Select Edit Improvement You can see the Edit API improvement screen now.

3. In the resulting window, fill in the following fields as required in the details tab.

4. Click Next

You are navigated to the Avatar tab.

5. Select an Avatar and color from the given options. If you want to set an image as the avatar, drop or browse an image from the system files.

6. Click Next. You are navigated to the Review tab. Review the entered details of the Edit API Improvement form.

7. Click Update API Improvement.

Your API improvement is successfully updated now.

To Delete Improvements

API project members can delete unwanted API improvements from Xapi.

To delete an API improvement, you have to view the API improvements first. For more information, see View Improvements.

In the resulting screen,

1. Click the vertical ellipsis on the selected API improvement.

2. Select Delete Improvement. A confirmation popup appears on your screen now.

3. In order to confirm the API improvement deletion, you need to fill the following details:

• API name * – Enter the given API improvement name.
• Reason to delete- the reason you are deleting the API improvement.

4. Click Yes, delete The API improvement has been deleted successfully.

API improvement delete permissions are based on the project member’s user role and the API feature’s status:

To Search Improvements

To search for an API improvement, you have to view the API improvements first. For more information, see View Improvements.

In the resulting screen,

Click on the search bar and type a phrase of the API improvement name that you want to search.

The matching search results appear in the All Improvement screen.