Skip to main content Skip to complementary content

Working with multiple versions

Talend Cloud API Designer allows you to work with several versions of the same API definition to help you manage your API life cycle. You can:

  • Maintain an existing API version in production while introducing significant or breaking changes in a new version.
  • Gain visibility and control on published versions.
  • Gain flexibility when designing changes to an API.

When you create a new version of an API, all content is copied to the new version and each version can then be modified independently without affecting the others.

The Talend Cloud API Designer homepage displays all APIs owned by you and all API versions shared with you.
Talend Cloud API Designer homepage.

Creating a new API version

Create a new version of an existing API definition.

Before you begin

You are an owner of the API or an editor of at least one version of the API.

Procedure

  1. On the homepage, go to the API for which you want to create a new version.
    You can filter the list by name or owner if needed.
  2. Click the Menu button next to the version that you want to copy and click Create a new version from <version> .
    View of the Movie catalog API and the Menu icon expanded for the 1.1.0 version.
  3. Enter the new version in the Version field.
  4. Click Create.

Results

A new version of your API is created with the same content as the source version. The mock and documentation are disabled by default.

Deleting an API version

Before you begin

You are an owner of the API.

Procedure

  1. On the homepage, click the Menu button next to the version that you want to delete and click Delete.
    Information noteNote: You cannot delete a version if its documentation is published on API Portal. You need to unpublish it or mark it as unpublished before deleting it. For more information, see Managing your API documentation.
  2. Click Delete to confirm.

Results

The selected version is deleted. If you want to delete an entire API, you need to delete each version.

Importing version content

Import content from an existing contract into an API version, replacing or merging its current content.

Before you begin

You are an owner of the API or an editor of the API version.

About this task

Use this feature to update a version from an external contract file without creating a new version. The version identifier is preserved throughout the import.

This is different from importing a definition, which creates a new API in Talend Cloud API Designer.

Procedure

  1. Open Import version content for the version you want to update.

    You can access this action from the following locations:

    • On the homepage, click the menu button next to the version and click Import version content.
      Import version content option in the menu button.
    • On the homepage, select the version to open the detail pane, then click Import version content.
      Import version content option in the version homepage.
    • In the version editor, click Edit > Import version content.
      Import version content option in the version editor.
  2. Select a format and a source for the contract to import.
    You can import from a local file, a URL, or text you paste directly into the dialog box.
  3. Under Behavior, select how to apply the imported content.
    • Replace: overwrites all current content with the imported contract. The API name, version identifier, and specification version are preserved.
    • Merge: combines the imported content with the existing version content. The API name and version identifier are preserved. If an imported element has the same name as an existing element, the imported element is renamed with a _merge suffix (for example, User_merge). Duplicate base URLs and media types are skipped.
    Import version content dialog box.
  4. Click Import.

Results

The version editor opens with the updated content applied.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!