Creating Bug Fix

The organization owner, organization admins, API designers, and API reviewers can add bug fix artifacts to authorized APIs and Models in premium organizations.

To add a new bug fix artifact to an API/Model:

💡

Before you begin:

Sign in to Xapi.
Navigate to the organization/project catalog where the API/Model for which you wish to add a new bug fix artifact exists.
Click on the corresponding API/Model.

📃

Note: Make sure your API/Model is in 'Done' state. To learn how to change API/Model ticket status, see Changing Ticket Status.

Hover over the top-right corner of a preferred API/Model version card. Note that a horizontal ellipsis appears.
Click Create > Bug.

Note that the Create New Bug Fix dialog appears.

Under DETAILS, enter bug fix artifact details as given below.

📃

Note:

Fields marked with an asterisk (*) are mandatory.
Fields marked with two asterisks (**) are not editable.

Field	Description	Sample Value
API bug fix name*	Briefly defines the bug fix.	`Wrong 200 Status for Missing Order in OrderManagementAPI`
API name**	The base API/Model name.	`OrderManagementAPI`
Project**	The project under which the base API/Model is created.	`Ordering`
Collection path**	The collection under which the base API/Model is created.	`Ordering /OrderManagementAPI/1.0`
Open API version**	The OpenAPI specification version of the base API/Model.	`3.1`
API version**	The base API/Model version.	`1.0`
Format**	The format in which your base API/Model data will be structured. - JSON - YAML	`JSON`
Protocol**	The protocol that your base API/Model will use to communicate. - REST	`REST`
Description	Describes your bug fix artifact purpose.

Click Next.
Under AVATAR, you may either upload an avatar or select an existing avatar.
Click Next.
Under REVIEW, you may review the entered details.

💡
Tip: You may change the entered bug fix details by going back to the previous tab.
Click Create. Upon successfully creating the bug fix, note that:
- A dedicated branch dedicated to the bug fix gets created under the corresponding API/Model version.
- You will be navigated to the editor view of your API/Model.
- Your new bug fix will appear in the Bugs screen of the corresponding Catalog.
- All authoriezd members will be notified via Activity Stream.

💡

What’s next? Learn how to:

Overview View