Refreshing a REST API Descriptor
If the Swagger document used to create a REST API descriptor (RAD) changes, you may want to refresh the RAD to reflect the recent changes or to refresh the RAD using a different Swagger document. For example, if you created a RAD from a Swagger document that has changed to include, edit, or remove an operation, path, or definition, you can refresh the RAD. Refreshing the RAD does the following:
Updates the RAD, its associated services, document types, or resources (for provider RAD) to reflect the changes.
Adds elements, such as services, document types, or resources (for provider RAD) to the RAD to reflect new elements in the updated Swagger document.
Removes RAD elements that correspond to elements that have been removed from the updated Swagger document.
For provider RAD, preserves any changes that you have made to the service implementation in the RAD.
For consumer RAD, re-generates the service implementation and overrides the previous data that you have added in the RAD.
Note:
In Designer, the option to refresh a RAD is available only for those RADs that are created using a Swagger document.
To refresh a REST API Descriptor
1. In the Package Navigator view, right click the RAD that you want to refresh.
2. Click Refresh REST API Descriptor.
3. Review the informational message about potential changes to the existing RAD 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 RAD. 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 RAD. If Designer cannot refresh a RAD, Designer rolls back to the last saved version of the RAD. If refresh is not successful, use the messages returned by Designer and Integration Server logs to determine the issue.