Synchronizing the Imported REST API Models in TIBCO Business Studio™ for BusinessWorks™

If a REST service developer has made changes to the service API after creating the service, the changes needs to be propagated to all the places where the service is used. You can check for updates to a Swagger file that has been imported into TIBCO Business Studio for BusinessWorks. The icon to the left of the Swagger file in the Project Explorer in the TIBCO Business Studio for BusinessWorks displays an indication that the file has been modified in its original location and the local copy of the file is not in synchronization with it source.

You can check for differences between the original Swagger file and its copy that was created when importing it into the TIBCO Business Studio for BusinessWorks. You can also compare the differences between the two and update your local copy if need be. To do so, follow these steps:

Procedure

  1. Right-click the Swagger file under Service Descriptors in the Project Explorer.
  2. Select Remote Interface.
    The Check for Differences menu option checks for differences between the imported copy and its original.

    The Compare Differences menu option first checks for differences between the imported copy of the Swagger file and its original. If there is a difference, the file will appear in the Synchronize tab and if you double click it there it displays the two files side by side with the differences highlighted.

    The Update Local Copy menu item updates the copy of the file in your workspace to match its original. It also regenerates the schema.

    Note: No changes are performed for processes that have already been created.