Adding paths to the OpenAPI descriptor

Use the context menu to add paths to the OpenAPI descriptor.

1. Right-click in the OpenAPI Editor and click New > Path Item Object.
   If any paths exist in the OpenAPI descriptor, they are displayed in a list.
2. Specify a path name in the Path name text box. Consider the following naming conventions:
   • Path names must be unique.
   • Any naming conflicts are flagged and the Finish button is disabled until all conflicts are resolved.
   • Ending forward slashes ( / ) are removed.

   To reduce errors, TPF Toolkit generates the required path parameters automatically. However, the type element for the required path parameter is not included because the type of the path parameter cannot be derived during path creation. A warning is displayed in the file as a reminder to add the element. To add this element, manually add a line within the OpenAPI descriptor where the warning denotes and add the type element. Valid types are: boolean, string, number or integer. For example, "type":"boolean".

3. Check Finish to add the path to the OpenAPI descriptor.