saveComponent

saveComponent(componentName: String; 
              example:       String; 
              description:   String);

The saveComponent method of the JadeOpenAPIGenerator class sets the example and description for a component to new values, using the parameters listed in the following table.

Parameter	Description
componentName	Name of the component that is to be modified
example	New value expressed in JSON for the example of the component
description	New value for the description of the component

If the component had an existing example or description, it is overridden with the new value.

Use this method to provide documentation of the component to readers of the specification.

2020.0.02 and higher