Skip navigation links

com.bea.wlp.rest.command
Annotation Type RestCommandDocumentation

@Retention(value=RUNTIME)
public @interface RestCommandDocumentation

Annotation used to describe the expected input to a RestCommand. This should be formatted in WADL XML format, which describes command methods as well as parameters that are accepted by RestCommand, including restrictions on those parameters. This annotation will be consumed by a documentation tool that will be used to generate documentation for all RestCommands in the system.

Annotation Type Required Member Summary

String	inputDescription
String	resultType

Annotation Type Optional Member Summary

String	commandName
String	descriptionText
String	errorCodes
String	inputExample
String	method
String	namespace
String	returnExample

Annotation Type Member Detail

inputDescription

public abstract String inputDescription

resultType

public abstract String resultType

descriptionText

public abstract String descriptionText

Default

""

namespace

public abstract String namespace

Default

""

commandName

public abstract String commandName

Default

""

inputExample

public abstract String inputExample

Default

""

returnExample

public abstract String returnExample

Default

""

errorCodes

public abstract String errorCodes

Default

""

method

public abstract String method

Default

""

Skip navigation links