Update API Modules

To update API Modules, you have to compare them against a schema. To do so, follow the steps below:

1. In Tosca Commander, select one of the following elements:

   • A Module folder that contains API Modules.

   • A ComponentFolder that contains API Modules and TestCases.

   • The project root element.

2. Navigate to the API Testing menu.

3. In the Message section, click Update Modules or select one of the following options from the drop-down menu:

   • Select From URI to scan the new schema definition from a URI. This is the default option.

   • Select From File to scan the new schema definition from a file.

4. In the subsequent dialog, specify the schema:

   • From URI: enter the URI of the service schema into the URI field.

   • From File: enter the file path of the schema file or click Browse to browse for it.

5. Under Module Identification, select how to identify the Module that you want to update:

   • Use Method and Resource of the Module.

   • Use operationId/description in schema, i.e. the operation ID or description that your Swagger or RAML contains.

6. Under New Modules, select Create new Modules in NEW Modules folder if you want the system to add new Modules in case of a schema change.

7. Under Update Areas, select which elements you want to update:

   • Select Request Modules, Response Modules, or both to update the Modules and all elements they contain.

   • To update only specific Module elements, select one or more of them: Resources, Params, Payloads, Status Codes.

     If you selected Use Method and Resource for the Module identification, the option Resources is not available in this step.

8. Under Module Attributes, select or clear the following check boxes:

   • Create Module Attributes for new Modules. This option is only available, if you selected Create new Modules in NEW Modules folder.

   • Create Module Attributes for new Nodes or Parameters.

9. Optionally, if you selected From URI, click on Advanced to enter Basic Authentication credentials or Proxy details.

10. Click OK to update your Modules.

The API Engine performs the update based on your specifications in the Update dialog and informs you about the process in the Update Log Summary.