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.
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
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.
Click the button next to the version that you want to copy and click
Create a new version from <version>.
Enter the new version in the Version field.
Optional: Clear the Copy sharing settings check box to reset the
sharing settings.
By default, if the source version is shared with other users or groups, the
same settings are copied to the new version. If you clear this check box, the new
version will inherit the sharing settings at the API level. For more information,
see Sharing a specific version of an API.
Optional: Edit your GitHub settings.
By default, if the source version is linked to GitHub, the same settings are
copied to the new version. You can change the branch and the path, or you can
clear the Copy GitHub settings check box to disable the
GitHub integration for the new version. You can then enable and configure it as
needed. For more information, see Pushing an API version to GitHub.
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
On the homepage, click the button next to the version that you want to delete and click
Delete version.
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.
Click Are you sure? to confirm.
Results
The selected version is deleted. If you want to delete an entire API, you need to
delete each version.
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!
button next to the version that you want to copy and click
Create a new version from <version>
.
