org.springframework.restdocs.payload

Class FieldDescriptor

java.lang.Object

org.springframework.restdocs.payload.FieldDescriptor

public class FieldDescriptor
extends Object

A description of a field found in a request or response payload

Author:

Andreas Evers, Andy Wilkinson

See Also:

PayloadDocumentation.fieldWithPath(String)

Method Summary

Modifier and Type	Method and Description
FieldDescriptor	description(String description) Specifies the description of the field
FieldDescriptor	optional() Marks the field as optional
FieldDescriptor	type(FieldType type) Specifies the type of the field

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

type

public FieldDescriptor type(FieldType type)

Specifies the type of the field

Parameters:

type - The type of the field

Returns:

this

optional

public FieldDescriptor optional()

Marks the field as optional

Returns:

this

description

public FieldDescriptor description(String description)

Specifies the description of the field

Parameters:

description - The field's description

Returns:

this