Junos Space SDK > Developer Guides > Junos Space Application Developer Guide > Programming with the Junos Space SDK > Using the Junos Space SDK Plug-in > Using the EJB-REST Wizard > REST Wizard Documentation Guide

REST Method Documentation

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:

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.