The Documentation panel of the Configure REST Method wizard page contains a complete javadoc preview for a method.
To edit method documentation, open the Edit Method Documentation dialog by clicking the Edit button in the upper-right corner. To edit the method parameter's description, use the Edit Method Parameter Description dialog.
Edit Method Documentation Dialog
To open the dialog, switch to the Documentation panel and click the Edit button in the upper-right corner. A method's documentation consists of several sections. Each sections has a corresponding tab inside the Edit Method Documentation dialog.
The complete list of all possible sections is:
- Summary. A brief description of a method. This
appears as a comment of each operation from the list located
in the beginning
of the URI documentation page. This is a common section.
- Description. A complete description of a method. This
appears in the particular
method's section of the URI
documentation page. This a common section.
The rest of the documentation sections reveal their content in the bottom of the particular method's section of the URI documentation page.
- Input XML. Contains a sample body XML. This is accessible only for those methods that have a body and support the XML input format. (for example)
- Input JSON. Same as Input XML, but applied to JSON (for example).
- Output XML. Contains sample output XML. This is accessible only for those methods that have output and support the XML output format (for example).
- Output JSON. Same as Output XML, but applied to JSON (for example).
- Patch XML. Contains sample patch input XML. This is accessible only for PATCH methods that support the XML format.
- Patch JSON. Same as patch XML, but applied to JSON.
Note that all sample XML and JSON bodies are auto-generated by the wizard, and auto-updated when the user changes an associated DTO field. Therefore, it is preferable that these documents are never edited manually, because, once they are edited, they will no longer be auto-updated by the wizard.
Edit Method Parameter Description Dialog
To open the dialog, switch to the Configure REST Method panel, select the desired parameter in the Request Parameters table, and click the Edit button to the right of the table. The dialog allows you to modify a description of a method parameter.
The result appears in the Description column of the Parameters table inside the particular method's section.
