Create new versions of assets to manage changes and maintain multiple
versions.
About this task
The versioning feature is available for top-level assets such as APIs, policy sequences, and products. You can version individual assets or include their dependent assets in the versioning operation.
When you create a new version, the system creates a version‑named folder in the
Explorer sidebar that contains the versioned files.
For APIs, the specification file is automatically included in the version folder.
Note: The versioning feature is only available in the asset
Explorer sidebar, not in the file explorer view.
Procedure
-
From the home page, select a project from the list.
- In the asset Explorer sidebar, right-click the asset you want to
version.
-
Select Create version from the context menu.
A dialog box appears where you can specify the new version details.
-
In the Create version dialog box, enter the new version number.
For example, if the current version is 1.0, you can enter 1.1
or 2.0 for the new version.
-
Choose whether to include dependent assets in the version:
- To version only the main asset file, leave the Version dependent assets checkbox unchecked.
- To version the asset along with all its dependent assets such as policy sequences referenced
by an API, select the Version dependent assets checkbox.
Note: When versioning an API without dependent assets, the API specification file is automatically included because it is created by default with every API.
-
If you selected to version dependent assets, review any version conflicts that appear.
The system checks if any dependent assets already exist with the same version number. If conflicts are detected:
- A notification displays indicating that conflicts exist.
- The system suggests alternative version numbers for the conflicting assets.
- You must resolve all conflicts before proceeding. The Create button remains disabled until conflicts are resolved.
For example, if a policy sequence referenced by your API already has version
1.0, and you try to create version 1.0 again, you must enter a
different version number that doesn't conflict such as 1.0.1.
-
Click Create to create the new version.
The system creates the new version. The following changes occur:
- The new version appears in the asset Explorer sidebar alongside the
original version.
- A new folder with the version name is created in the file explorer.
- The asset files are copied as-is into the new version folder, but the version number in the files is updated.
- If you included dependent assets, new versions of those assets are also created in their respective folders.
What to do next
After creating a version, you can continue to work with both the original and new versions independently. Each version maintains its own set of files and configurations.