Designer 10.7 | webMethods Service Development Help | Working with REST API Descriptors | Swagger-Based Provider REST API Descriptors | About REST Definitions
 
About REST Definitions
The REST Definitions tab for a REST API descriptor (RAD) provides a consolidated view of the parameters used by the operations for the REST resources included in the RAD. The contents of the REST Definitions tab become the definitions object in the Swagger document.
Integration Server creates a REST definition for each of the following:
*Input parameter that is a Document, Document List, Document Reference, or Document Reference List.
*An input signature that includes the above along with one or more scalar parameters. The REST definition includes the scalar parameters and a reference to the REST definition created for the Document, Document List, Document Reference, or Document Reference.
*Output parameters returned by an operation.
The REST Definitions tab allows you to modify the external document details for each definition.
*Modifying the external document details
1. To modify the external reference for the definition, click next to External Docs.
2. In the Update External Doc dialog box, add the description and URL for the external document and click OK.
The new external document details are displayed in the text box below External Docs.
3. To remove an existing external document details for the definition, click next to External Docs.
To clear the existing external document details click next to External Docs.
4. Click File > Save.
For information about REST Definitions properties, see REST Definition Properties and REST Definition Parameter Properties.