Specifying an Example and Description for each Component

The fourth sheet of the OpenAPI Generation Wizard is the Components sheet, shown in the following image, which enables you to specify an example and description for each component, as well as a description for each property of each component.

The values derived from each class referenced by a method of the Jade REST class or another component, as well as your specified component example and description values are generated in the "components" section of the OpenAPI specification.

The Components list box displays the components (classes) that are referenced by the Jade REST class included in the OpenAPI specification.

To modify the example and description for a component

1. Select the component in the Components list box.

   The name of that component is then displayed under Component Name, any current values of the example and description are displayed in the Component Summary and Component Description text boxes, and the Component Properties list box is populated with the properties of that component, if any.

2. In the Component Example and Component Description text boxes, specify the required example and description of the component.

3. To apply your changes, click the Save button on the left of the sheet.

To modify the description of the properties of the selected component

1. Select the required property in the Properties list box.

2. In the Property Description text box, specify the description you require for the property.

3. To save the property description without saving any other changes to the property, click the Save button on the right of the sheet.

To abandon your changes and revert to the component default values

• Click the Reset button.

For details about the tags for component class and property default values, see "Setting Default Values for API Documentation Information", elsewhere in this chapter.

To proceed to another sheet of the wizard

• Click the tab of the required sheet or click the Back button.

• Alternatively, you can:

  • Click on the tab of any sheet of the wizard at any time to navigate directly to that sheet.

  • Click the Generate button, to generate the OpenAPI Specification dialog.

2020.0.02 and higher