Uses of Class
org.springframework.restdocs.payload.FieldDescriptor

Packages that use FieldDescriptor

Package	Description
org.springframework.restdocs.payload	Documenting the payload of a RESTful API's requests and responses.

Uses of FieldDescriptor in org.springframework.restdocs.payload

Subclasses of FieldDescriptor in org.springframework.restdocs.payload

Modifier and Type	Class	Description
class	SubsectionDescriptor	A description of a subsection, i.e.

Methods in org.springframework.restdocs.payload that return FieldDescriptor

Modifier and Type	Method	Description
static FieldDescriptor	PayloadDocumentation.fieldWithPath(String path)	Creates a FieldDescriptor that describes a field with the given path.
final FieldDescriptor	FieldDescriptor.optional()	Marks the field as optional.
final FieldDescriptor	FieldDescriptor.type(Object type)	Specifies the type of the field.

Methods in org.springframework.restdocs.payload that return types with arguments of type FieldDescriptor

Modifier and Type	Method	Description
static List<FieldDescriptor>	PayloadDocumentation.applyPathPrefix(String pathPrefix, List<FieldDescriptor> descriptors)	Creates a copy of the given descriptors with the given pathPrefix applied to their paths.
protected final List<FieldDescriptor>	AbstractFieldsSnippet.getFieldDescriptors()	Returns the list of FieldDescriptors that will be used to generate the documentation.

Methods in org.springframework.restdocs.payload with parameters of type FieldDescriptor

Modifier and Type	Method	Description
final RequestFieldsSnippet	RequestFieldsSnippet.and(FieldDescriptor... additionalDescriptors)	Returns a new RequestFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
final RequestPartFieldsSnippet	RequestPartFieldsSnippet.and(FieldDescriptor... additionalDescriptors)	Returns a new RequestPartFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
final ResponseFieldsSnippet	ResponseFieldsSnippet.and(FieldDescriptor... additionalDescriptors)	Returns a new ResponseFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
final RequestFieldsSnippet	RequestFieldsSnippet.andWithPrefix(String pathPrefix, FieldDescriptor... additionalDescriptors)	Returns a new RequestFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
final RequestPartFieldsSnippet	RequestPartFieldsSnippet.andWithPrefix(String pathPrefix, FieldDescriptor... additionalDescriptors)	Returns a new RequestFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
final ResponseFieldsSnippet	ResponseFieldsSnippet.andWithPrefix(String pathPrefix, FieldDescriptor... additionalDescriptors)	Returns a new ResponseFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
protected Map<String,Object>	AbstractFieldsSnippet.createModelForDescriptor(FieldDescriptor descriptor)	Returns a model for the given descriptor.
static RequestFieldsSnippet	PayloadDocumentation.relaxedRequestFields(Map<String,Object> attributes, FieldDescriptor... descriptors)	Returns a Snippet that will document the fields of the API operation's request payload.
static RequestFieldsSnippet	PayloadDocumentation.relaxedRequestFields(FieldDescriptor... descriptors)	Returns a Snippet that will document the fields of the API operations's request payload.
static RequestFieldsSnippet	PayloadDocumentation.relaxedRequestFields(PayloadSubsectionExtractor<?> subsectionExtractor, Map<String,Object> attributes, FieldDescriptor... descriptors)	Returns a Snippet that will document the fields of the subsection of the API operation's request payload extracted by the given subsectionExtractor.
static RequestFieldsSnippet	PayloadDocumentation.relaxedRequestFields(PayloadSubsectionExtractor<?> subsectionExtractor, FieldDescriptor... descriptors)	Returns a Snippet that will document the fields of the subsection of the API operations's request payload extracted by the given subsectionExtractor .
static RequestPartFieldsSnippet	PayloadDocumentation.relaxedRequestPartFields(String part, Map<String,Object> attributes, FieldDescriptor... descriptors)	Returns a Snippet that will document the fields of the specified part of the API operations's request payload.
static RequestPartFieldsSnippet	PayloadDocumentation.relaxedRequestPartFields(String part, FieldDescriptor... descriptors)	Returns a Snippet that will document the fields of the specified part of the API operations's request payload.
static RequestPartFieldsSnippet	PayloadDocumentation.relaxedRequestPartFields(String part, PayloadSubsectionExtractor<?> subsectionExtractor, Map<String,Object> attributes, FieldDescriptor... descriptors)	Returns a Snippet that will document the fields of a subsection of the specified part of the API operations's request payload.
static RequestPartFieldsSnippet	PayloadDocumentation.relaxedRequestPartFields(String part, PayloadSubsectionExtractor<?> subsectionExtractor, FieldDescriptor... descriptors)	Returns a Snippet that will document the fields of a subsection of the specified part of the API operations's request payload.
static ResponseFieldsSnippet	PayloadDocumentation.relaxedResponseFields(Map<String,Object> attributes, FieldDescriptor... descriptors)	Returns a Snippet that will document the fields of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.relaxedResponseFields(FieldDescriptor... descriptors)	Returns a Snippet that will document the fields of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.relaxedResponseFields(PayloadSubsectionExtractor<?> subsectionExtractor, Map<String,Object> attributes, FieldDescriptor... descriptors)	Returns a Snippet that will document the fields of a subsection of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.relaxedResponseFields(PayloadSubsectionExtractor<?> subsectionExtractor, FieldDescriptor... descriptors)	Returns a Snippet that will document the fields of a subsection of the API operation's response payload.
static RequestFieldsSnippet	PayloadDocumentation.requestFields(Map<String,Object> attributes, FieldDescriptor... descriptors)	Returns a Snippet that will document the fields of the API operation's request payload.
static RequestFieldsSnippet	PayloadDocumentation.requestFields(FieldDescriptor... descriptors)	Returns a Snippet that will document the fields of the API operations's request payload.
static RequestFieldsSnippet	PayloadDocumentation.requestFields(PayloadSubsectionExtractor<?> subsectionExtractor, Map<String,Object> attributes, FieldDescriptor... descriptors)	Returns a Snippet that will document the fields of the subsection of the API operation's request payload extracted by the given subsectionExtractor.
static RequestFieldsSnippet	PayloadDocumentation.requestFields(PayloadSubsectionExtractor<?> subsectionExtractor, FieldDescriptor... descriptors)	Returns a Snippet that will document the fields of the subsection of API operations's request payload extracted by the given subsectionExtractor.
static RequestPartFieldsSnippet	PayloadDocumentation.requestPartFields(String part, Map<String,Object> attributes, FieldDescriptor... descriptors)	Returns a Snippet that will document the fields of the specified part of the API operations's request payload.
static RequestPartFieldsSnippet	PayloadDocumentation.requestPartFields(String part, FieldDescriptor... descriptors)	Returns a Snippet that will document the fields of the specified part of the API operations's request payload.
static RequestPartFieldsSnippet	PayloadDocumentation.requestPartFields(String part, PayloadSubsectionExtractor<?> subsectionExtractor, Map<String,Object> attributes, FieldDescriptor... descriptors)	Returns a Snippet that will document the fields of a subsection of the specified part of the API operations's request payload.
static RequestPartFieldsSnippet	PayloadDocumentation.requestPartFields(String part, PayloadSubsectionExtractor<?> subsectionExtractor, FieldDescriptor... descriptors)	Returns a Snippet that will document the fields of a subsection of the specified part of the API operations's request payload.
Object	FieldTypeResolver.resolveFieldType(FieldDescriptor fieldDescriptor)	Resolves the type of the field that is described by the given fieldDescriptor based on the content of the payload.
static ResponseFieldsSnippet	PayloadDocumentation.responseFields(Map<String,Object> attributes, FieldDescriptor... descriptors)	Returns a Snippet that will document the fields of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.responseFields(FieldDescriptor... descriptors)	Returns a Snippet that will document the fields of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.responseFields(PayloadSubsectionExtractor<?> subsectionExtractor, Map<String,Object> attributes, FieldDescriptor... descriptors)	Returns a Snippet that will document the fields of a subsection of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.responseFields(PayloadSubsectionExtractor<?> subsectionExtractor, FieldDescriptor... descriptors)	Returns a Snippet that will document the fields of a subsection of the API operation's response payload.

Method parameters in org.springframework.restdocs.payload with type arguments of type FieldDescriptor

Modifier and Type	Method	Description
final RequestFieldsSnippet	RequestFieldsSnippet.and(List<FieldDescriptor> additionalDescriptors)	Returns a new RequestFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
final RequestPartFieldsSnippet	RequestPartFieldsSnippet.and(List<FieldDescriptor> additionalDescriptors)	Returns a new RequestPartFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
final ResponseFieldsSnippet	ResponseFieldsSnippet.and(List<FieldDescriptor> additionalDescriptors)	Returns a new ResponseFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
final RequestFieldsSnippet	RequestFieldsSnippet.andWithPrefix(String pathPrefix, List<FieldDescriptor> additionalDescriptors)	Returns a new RequestFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
final RequestPartFieldsSnippet	RequestPartFieldsSnippet.andWithPrefix(String pathPrefix, List<FieldDescriptor> additionalDescriptors)	Returns a new RequestFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
final ResponseFieldsSnippet	ResponseFieldsSnippet.andWithPrefix(String pathPrefix, List<FieldDescriptor> additionalDescriptors)	Returns a new ResponseFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
static List<FieldDescriptor>	PayloadDocumentation.applyPathPrefix(String pathPrefix, List<FieldDescriptor> descriptors)	Creates a copy of the given descriptors with the given pathPrefix applied to their paths.
byte[]	FieldPathPayloadSubsectionExtractor.extractSubsection(byte[] payload, org.springframework.http.MediaType contentType, List<FieldDescriptor> descriptors)
default byte[]	PayloadSubsectionExtractor.extractSubsection(byte[] payload, org.springframework.http.MediaType contentType, List<FieldDescriptor> descriptors)	Extracts a subsection of the given payload that has the given contentType and that is described by the given descriptors.
static FieldTypeResolver	FieldTypeResolver.forContentWithDescriptors(byte[] content, org.springframework.http.MediaType contentType, List<FieldDescriptor> descriptors)	Create a FieldTypeResolver for the given content and contentType, described by the given descriptors.
static RequestFieldsSnippet	PayloadDocumentation.relaxedRequestFields(List<FieldDescriptor> descriptors)	Returns a Snippet that will document the fields of the API operations's request payload.
static RequestFieldsSnippet	PayloadDocumentation.relaxedRequestFields(Map<String,Object> attributes, List<FieldDescriptor> descriptors)	Returns a Snippet that will document the fields of the API operation's request payload.
static RequestFieldsSnippet	PayloadDocumentation.relaxedRequestFields(PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors)	Returns a Snippet that will document the fields of the subsection of the API operations's request payload extracted by the given subsectionExtractor .
static RequestFieldsSnippet	PayloadDocumentation.relaxedRequestFields(PayloadSubsectionExtractor<?> subsectionExtractor, Map<String,Object> attributes, List<FieldDescriptor> descriptors)	Returns a Snippet that will document the fields of the subsection of the API operation's request payload extracted by the given subsectionExtractor.
static RequestPartFieldsSnippet	PayloadDocumentation.relaxedRequestPartFields(String part, List<FieldDescriptor> descriptors)	Returns a Snippet that will document the fields of the specified part of the API operations's request payload.
static RequestPartFieldsSnippet	PayloadDocumentation.relaxedRequestPartFields(String part, Map<String,Object> attributes, List<FieldDescriptor> descriptors)	Returns a Snippet that will document the fields of the specified part of the API operations's request payload.
static RequestPartFieldsSnippet	PayloadDocumentation.relaxedRequestPartFields(String part, PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors)	Returns a Snippet that will document the fields of a subsection of the specified part of the API operations's request payload.
static RequestPartFieldsSnippet	PayloadDocumentation.relaxedRequestPartFields(String part, PayloadSubsectionExtractor<?> subsectionExtractor, Map<String,Object> attributes, List<FieldDescriptor> descriptors)	Returns a Snippet that will document the fields of a subsection of the specified part of the API operations's request payload.
static ResponseFieldsSnippet	PayloadDocumentation.relaxedResponseFields(List<FieldDescriptor> descriptors)	Returns a Snippet that will document the fields of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.relaxedResponseFields(Map<String,Object> attributes, List<FieldDescriptor> descriptors)	Returns a Snippet that will document the fields of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.relaxedResponseFields(PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors)	Returns a Snippet that will document the fields of a subsection of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.relaxedResponseFields(PayloadSubsectionExtractor<?> subsectionExtractor, Map<String,Object> attributes, List<FieldDescriptor> descriptors)	Returns a Snippet that will document the fields of a subsection of the API operation's response payload.
static RequestFieldsSnippet	PayloadDocumentation.requestFields(List<FieldDescriptor> descriptors)	Returns a Snippet that will document the fields of the API operations's request payload.
static RequestFieldsSnippet	PayloadDocumentation.requestFields(Map<String,Object> attributes, List<FieldDescriptor> descriptors)	Returns a Snippet that will document the fields of the API operation's request payload.
static RequestFieldsSnippet	PayloadDocumentation.requestFields(PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors)	Returns a Snippet that will document the fields in the subsection of the API operations's request payload extracted by the given subsectionExtractor .
static RequestFieldsSnippet	PayloadDocumentation.requestFields(PayloadSubsectionExtractor<?> subsectionExtractor, Map<String,Object> attributes, List<FieldDescriptor> descriptors)	Returns a Snippet that will document the fields of the subsection of the API operation's request payload extracted by the given subsectionExtractor.
static RequestPartFieldsSnippet	PayloadDocumentation.requestPartFields(String part, List<FieldDescriptor> descriptors)	Returns a Snippet that will document the fields of the specified part of the API operations's request payload.
static RequestPartFieldsSnippet	PayloadDocumentation.requestPartFields(String part, Map<String,Object> attributes, List<FieldDescriptor> descriptors)	Returns a Snippet that will document the fields of the specified part of the API operations's request payload.
static RequestPartFieldsSnippet	PayloadDocumentation.requestPartFields(String part, PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors)	Returns a Snippet that will document the fields of a subsection of the specified part of the API operations's request payload.
static RequestPartFieldsSnippet	PayloadDocumentation.requestPartFields(String part, PayloadSubsectionExtractor<?> subsectionExtractor, Map<String,Object> attributes, List<FieldDescriptor> descriptors)	Returns a Snippet that will document the fields of a subsection of the specified part of the API operations's request payload.
static ResponseFieldsSnippet	PayloadDocumentation.responseFields(List<FieldDescriptor> descriptors)	Returns a Snippet that will document the fields of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.responseFields(Map<String,Object> attributes, List<FieldDescriptor> descriptors)	Returns a Snippet that will document the fields of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.responseFields(PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors)	Returns a Snippet that will document the fields of a subsection of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.responseFields(PayloadSubsectionExtractor<?> subsectionExtractor, Map<String,Object> attributes, List<FieldDescriptor> descriptors)	Returns a Snippet that will document the fields of a subsection of the API operation's response payload.

Constructor parameters in org.springframework.restdocs.payload with type arguments of type FieldDescriptor

Modifier	Constructor	Description
protected	AbstractFieldsSnippet(String name, String type, List<FieldDescriptor> descriptors, Map<String,Object> attributes, boolean ignoreUndocumentedFields)	Creates a new AbstractFieldsSnippet that will produce a snippet named <name>-fields using a template named <type>-fields.
protected	AbstractFieldsSnippet(String name, String type, List<FieldDescriptor> descriptors, Map<String,Object> attributes, boolean ignoreUndocumentedFields, PayloadSubsectionExtractor<?> subsectionExtractor)	Creates a new AbstractFieldsSnippet that will produce a snippet named <name>-fields using a template named <type>-fields.
protected	AbstractFieldsSnippet(String type, List<FieldDescriptor> descriptors, Map<String,Object> attributes, boolean ignoreUndocumentedFields)	Creates a new AbstractFieldsSnippet that will produce a snippet named <type>-fields using a template named <type>-fields.
protected	AbstractFieldsSnippet(String type, List<FieldDescriptor> descriptors, Map<String,Object> attributes, boolean ignoreUndocumentedFields, PayloadSubsectionExtractor<?> subsectionExtractor)	Creates a new AbstractFieldsSnippet that will produce a snippet named <type>-fields using a template named <type>-fields.
protected	RequestFieldsSnippet(List<FieldDescriptor> descriptors)	Creates a new RequestFieldsSnippet that will document the fields in the request using the given descriptors.
protected	RequestFieldsSnippet(List<FieldDescriptor> descriptors, boolean ignoreUndocumentedFields)	Creates a new RequestFieldsSnippet that will document the fields in the request using the given descriptors.
protected	RequestFieldsSnippet(List<FieldDescriptor> descriptors, Map<String,Object> attributes)	Creates a new RequestFieldsSnippet that will document the fields in the request using the given descriptors.
protected	RequestFieldsSnippet(List<FieldDescriptor> descriptors, Map<String,Object> attributes, boolean ignoreUndocumentedFields)	Creates a new RequestFieldsSnippet that will document the fields in the request using the given descriptors.
protected	RequestFieldsSnippet(PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors)	Creates a new RequestFieldsSnippet that will document the fields in the subsection of the request extracted by the given subsectionExtractor using the given descriptors.
protected	RequestFieldsSnippet(PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors, boolean ignoreUndocumentedFields)	Creates a new RequestFieldsSnippet that will document the fields in the subsection of the request extracted by the given subsectionExtractor using the given descriptors.
protected	RequestFieldsSnippet(PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors, Map<String,Object> attributes)	Creates a new RequestFieldsSnippet that will document the fields in the subsection of the request extracted by the given subsectionExtractor using the given descriptors.
protected	RequestFieldsSnippet(PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors, Map<String,Object> attributes, boolean ignoreUndocumentedFields)	Creates a new RequestFieldsSnippet that will document the fields in the subsection of the request extracted by the given subsectionExtractor using the given descriptors.
protected	RequestPartFieldsSnippet(String partName, List<FieldDescriptor> descriptors)	Creates a new RequestPartFieldsSnippet that will document the fields in the request part using the given descriptors.
protected	RequestPartFieldsSnippet(String partName, List<FieldDescriptor> descriptors, boolean ignoreUndocumentedFields)	Creates a new RequestPartFieldsSnippet that will document the fields in the request part using the given descriptors.
protected	RequestPartFieldsSnippet(String partName, List<FieldDescriptor> descriptors, Map<String,Object> attributes)	Creates a new RequestFieldsSnippet that will document the fields in the request using the given descriptors.
protected	RequestPartFieldsSnippet(String partName, List<FieldDescriptor> descriptors, Map<String,Object> attributes, boolean ignoreUndocumentedFields)	Creates a new RequestFieldsSnippet that will document the fields in the request using the given descriptors.
protected	RequestPartFieldsSnippet(String partName, PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors)	Creates a new RequestPartFieldsSnippet that will document the fields in a subsection of the request part using the given descriptors.
protected	RequestPartFieldsSnippet(String partName, PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors, boolean ignoreUndocumentedFields)	Creates a new RequestPartFieldsSnippet that will document the fields in a subsection the request part using the given descriptors.
protected	RequestPartFieldsSnippet(String partName, PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors, Map<String,Object> attributes)	Creates a new RequestPartFieldsSnippet that will document the fields in a subsection of the request part using the given descriptors.
protected	RequestPartFieldsSnippet(String partName, PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors, Map<String,Object> attributes, boolean ignoreUndocumentedFields)	Creates a new RequestPartFieldsSnippet that will document the fields in a subsection of the request part using the given descriptors.
protected	ResponseFieldsSnippet(List<FieldDescriptor> descriptors)	Creates a new ResponseFieldsSnippet that will document the fields in the response using the given descriptors.
protected	ResponseFieldsSnippet(List<FieldDescriptor> descriptors, boolean ignoreUndocumentedFields)	Creates a new ResponseFieldsSnippet that will document the fields in the response using the given descriptors.
protected	ResponseFieldsSnippet(List<FieldDescriptor> descriptors, Map<String,Object> attributes)	Creates a new ResponseFieldsSnippet that will document the fields in the response using the given descriptors.
protected	ResponseFieldsSnippet(List<FieldDescriptor> descriptors, Map<String,Object> attributes, boolean ignoreUndocumentedFields)	Creates a new ResponseFieldsSnippet that will document the fields in the response using the given descriptors.
protected	ResponseFieldsSnippet(PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors)	Creates a new ResponseFieldsSnippet that will document the fields in a subsection of the response using the given descriptors.
protected	ResponseFieldsSnippet(PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors, boolean ignoreUndocumentedFields)	Creates a new ResponseFieldsSnippet that will document the fields in the subsection of the response using the given descriptors.
protected	ResponseFieldsSnippet(PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors, Map<String,Object> attributes)	Creates a new ResponseFieldsSnippet that will document the fields in a subsection of the response using the given descriptors.
protected	ResponseFieldsSnippet(PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors, Map<String,Object> attributes, boolean ignoreUndocumentedFields)	Creates a new ResponseFieldsSnippet that will document the fields in a subsection of the response using the given descriptors.