Creating Improvement

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

To add a new improvement artifact to an API/Model:

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

   
   

2. Click Create > Improvement.

   
   

   Note that the Create New Improvement dialog appears.

   
   

3. Under DETAILS, enter improvement 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 improvement name*	Briefly defines the improvement.	Add Order Status History Endpoint
   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 data will be structured. - JSON - YAML	JSON
   Protocol**	The protocol that your base API/Model will use to communicate. - REST	REST
   Description	Describes your improvement artifact purpose.

4. Click Next.

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

   
   

6. Click Next.

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

   
   
   💡

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

8. Click Create. Upon successfully creating the improvement, note that:

   • A dedicated branch dedicated to the improvement gets created under the corresponding API/Model version.
   • You will be navigated to the editor view of your API/Model.
   • Your new improvement will appear in the Improvements screen of the corresponding Catalog.
   • All authorized members will be notified via Activity Stream.