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 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
- ""
Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
Other names may be trademarks of their respective owners.