xapi-logo
Solutions icon
Features icon
Resources and Support icon
PricingXapi HubPublic Editor xapi editor
Start Xapi For Free
User Guides
Artifacts
Features
Create

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:

  1. Sign in to Xapi.
  2. Navigate to the organization/project catalog where the API/Model for which you wish to add a new feature artifact exists.
  3. 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.

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


    API card horizontal ellipsis option
  2. Click Create > Feature.


    Create Feature ellipsis option

    Note that the Create New Feature dialog appears.


    Feature details entry
  3. 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.
    FieldDescriptionSample 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
    DescriptionDescribes your feature artifact purpose.
  4. Click Next.

  5. Under AVATAR, you may either upload an avatar or select an existing avatar.


    New feature avatar selection
  6. Click Next.

  7. Under REVIEW, you may review the entered API details.


    Feature details review
    πŸ’‘

    Tip: You may change the entered feature details by going back to the previous tab.

  8. 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.