com.yepher.jsondoc.annotations

Annotation Type RequestPDU

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface RequestPDU

this annotation is used to identify a request PDU.

Author:

jrenkel

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
RequestPDU.Method[]	method
String[]	multipartPostParts
boolean	noSample
String[]	path
String[]	pathParameters
String[]	requestParameters
Class<?>[]	response

Element Detail

method

public abstract RequestPDU.Method[] method

Default:

com.yepher.jsondoc.annotations.RequestPDU.Method.POST

path

public abstract String[] path

Default:

{}

pathParameters

public abstract String[] pathParameters

Default:

{}

requestParameters

public abstract String[] requestParameters

Default:

{}

multipartPostParts

public abstract String[] multipartPostParts

Default:

{}

response

public abstract Class<?>[] response

Default:

{}

noSample

public abstract boolean noSample

Default:

false