Contact Us 1-800-596-4880

Manage Versions

Manage the versions of an asset by viewing version detail, adding a new version, deleting a version, and changing the lifecycle state for a version.

View Version Detail

You can view the following information about a version of an asset:

  • Name of the owner who published the asset

  • Date the version was published

  • Lifecycle status

To view the details of a version:

  1. Click Manage versions in the expanded asset details pane.

  2. Click the three dots menu and choose Version detail from the menu.

Add New Version of an Asset

If you have contributor or admin access to an asset, you can add a new version for an asset. The new version of the asset has the same name, icon, and description as the previous version. Any changes to these properties apply to all versions of the asset.

  1. Click Manage versions in the expanded asset details pane.

  2. Click Add new version.

  3. (Required for APIs) Select a Method for the API specification.

  4. (Required for APIs) From File upload click Choose file. For OAS, choose an OAS file with the .yaml or .json file types. For RAML, choose a RAML file with the .raml file type. Zip files are also accepted with the file to upload residing in the zip file’s root directory.

  5. Specify the Main file if the uploaded file is a zip. Otherwise, Exchange uses the same file name as the file you upload.

  6. (Required) In Version , enter a new version for the asset.

  7. (Required) In the *API version, enter the version of the API specification. The Version and API version values must agree. You can only choose minor version updates for a given API version. To set a major Version number, also increase the API version. If you choose minor or patch version updates, the API versions should not changed.

  8. Select a Lifecycle state. The default is Stable.

  9. Click Publish

Delete a Version of an Asset

You can delete versions of an asset. If you try to delete an asset version with dependent assets, Exchange shows a warning. Remove the dependencies and then delete the asset version.

  1. Click Manage versions in the expanded asset details pane.

  2. Click the three dots menu and choose Delete version from the menu.

  3. Click Delete version from the confirmation dialog.

Change Lifecycle State for a Version of an Asset

The lifecycle state for a version of an asset can be changed depending on the following state promotions:

  • development to stable

  • stable to deprecated

  • deprecated to stable

If an asset in the development state depends on one or more other assets in the development state, Exchange does not allow promoting that asset to the stable state. All its dependencies must first be promoted to stable.

  1. Click Manage versions in the expanded asset details pane.

  2. From the drop-down menu next to the lifecycle state that you want to change, choose a state following the correct promotion path.

  3. Click Close.

Manage Policy Implementation Version

From the asset details page in Exchange, manage the implementation versions of a policy asset from the Manage implementations table, which displays the latest version. You can view, add, and delete versions:

  1. Click Implementations from the left navigation bar.

  2. To manage the versions of an implementation, click the more options menu and select an option:

    1. To view the versions, select Implementation versions.

    2. To add a new version, select Add new version and enter the version.

    3. To delete a version, select Delete version.

  3. Click Close.

Update Policy Implementations

To update policy implementations to be compatible with your Flex Gateway version:

  1. Go to the Policies page.

  2. Under Applied policy status, you’ll see the policies that need updating. Click the more options menu icon and click Check for implementation updates.

  3. The newest policy implementation compatible with your current version shows.
    An error message will show if you have no policy implementations compatible with your current Flex Gateway version. See Add Policy Implementation Files to Published Policy Definition for more info.

  4. In the confirmation dialog box, click Update all.

    The policy displays under API-level policies.

This action cannot be undone.

For automated policies:

  1. Go to the Automated Policies page.

  2. Under Applied automated policy status, you’ll see the policies that need updating. Click the more options menu icon and click See covered APIs to get a list of the APIs using the incompatible policy.

    • If you want to remove the policy from the APIs, click Remove the automated Policy.

      • The automated policy is removed from the APIs.

    • If you want to update the policy implementation to a compatible version, click Check for updates.

      • A list of all available policy implementations for your current version shows.

      • In the confirmation dialog box, click Update all.

      • The policy displays under Automated policies.

This action cannot be undone.