Creating Feature
The organization owner, organization admins, API designers, and API reviewers can add feature artifacts to authorized APIs and Models in premium organizations.
To add a new feature 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 feature 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 > Feature.
Note that the Create New Feature dialog appears.
-
Under DETAILS, enter feature 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 feature name* Briefly defines the feature. Ability to add new menu item to an existing menu
API name** The base API/Model name. OrderManagementAPI
Project** The project under which the base API/Model is created. default project
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 is structured. - - JSON
- - YAML
JSON
Protocol** The protocol that your base API/Model will use to communicate. - - REST
REST
Description Describes your feature 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 API details.
π‘Tip: You may change the entered feature details by going back to the previous tab.
-
Click Create. Upon successfully creating the feature, note that:
- A dedicated branch dedicated to the feature gets created under the corresponding API/Model version.
- You will be navigated to the editor view of your API/Model.
- Your new feature will appear in the Features screen of the corresponding Catalog.
- All authorized members will be notified via Activity Stream.
Whatβs next? Learn how to: