Versioning APIs

The organization owner, organization admins, and API designers can create versions for both internal and external APIs in authorized organizations and projects (if exist).

Creating new API version

To create a new API version:

1. Hover over the top-right corner of the API card you want to version. Note that a horizontal ellipsis appears.

   
   

2. Click Create New Version.

   
   

   Note that the New API Version dialog appears.

   
   

3. Under DETAILS, update API details as given below.

   📃

   Note:

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

   Field	Description	Sample Value
   Open API version*	This is the OpenAPI specification version that will be applicable to your API.	3.1
   Base version*	This is to identify the base API's version.	1.0
   New API version*	This is to identify the new API version.	2.0
   API name**	This uniquely identifies the API within the corresponding catalog.	OrderManagementAPI
   Project**	This identifies the project under which the API is created. 💡 Tip: - If the API is created under a default organization, this will be set to default project. - If the API is created under a project, this will be set to the corresponding project name.	default project
   Collection path**	This is the catalog under which the API is created.	Orders Catalog
   Format**	This defines the format in which your API data will be structured. - JSON - YAML	JSON
   Protocol**	This defines the protocol that your API will use to communicate. - REST	REST
   API tags**	This is to classify your API. Depending on the tags selected, the API can be filtered in API Hub.	Food
   Avatar**	This is to visually identify the API
   Description	This describes your API purpose.	This is a private API located in the Orders Catalog.

4. Click Next.

5. Under REVIEW, you may review the entered API version details.

   
   
   💡

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

6. Click Create API. Upon successfully creating the API version, note that:

   • You will be navigated to the editor view of your API.

   • The number of API versions in the corresponding API will appear in the API card view in the corresponding catalog.

     
     

   • All authoriezd members will be notified via Activity Stream.

Viewing API versions

To view existing API versions:

1. Click the API Versions icon on the corresponding API card.

   
   

   Note that the API versions screen appears.