B2B Integration 10.2 | Administering and Monitoring B2B Transactions | Service Development Help | Working with REST API Descriptors | Creating a REST API Descriptor from a Swagger Document | Refreshing a REST API Descriptor
 
Refreshing a REST API Descriptor
If the Swagger document used to create a REST API descriptor changes, you may want to refresh the REST API descriptor to reflect the recent changes or to refresh the REST API descriptor using a different Swagger document. For example, if you created a REST API descriptor from a Swagger document that has since changed to include, edit, or remove an peration, path, or definition, you can refresh the REST API descriptor. Refreshing the REST API descriptor does the following:
*Updates the REST API descriptor, its associated services, document types, or resources to reflect changes in existing elements in the updated Swagger document.
*Adds elements, such as services, document types, or resources to the REST API descriptor to reflect new elements in the updated Swagger document.
*Removes REST API descriptor elements that correspond to elements that have been removed from the updated Swagger document.
*Preserves any changes you made to the service implementation in the REST API descriptor since it was created from the original Swagger document.
Note: In Designer, the option to refresh a REST API descriptor is available only for those REST API descriptors that are created using a Swagger document.
* To refresh a REST API Descriptor
1. In the Package Navigator view, right click the Rest API descriptor that you want to refresh.
2. Click Refresh REST API Descriptor.
3. Review the informational message about potential changes to the existing REST API descriptor and click OK to continue with refresh.
4. If the Source URI property specifies a location for the original Swagger document, if there is a change in the Swagger document location, specify the new location of the file for refreshing the REST API descriptor. Click Yes to the Swagger document for which the location has changed or click No to use the file at the specified location as the source.
Designer refreshes the REST API descriptor. If Designer cannot refresh a REST API descriptor, Designer rolls back to the last saved version of the REST API descriptor. If refresh is not successful, use the messages returned by Designer and Integration Server logs to determine the issue.
Copyright © 2016- 2019 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.