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

Packages that use RequestFieldsSnippet

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

Uses of RequestFieldsSnippet in org.springframework.restdocs.payload

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

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 RequestFieldsSnippet	RequestFieldsSnippet.and(FieldDescriptor... additionalDescriptors)	Returns a new RequestFieldsSnippet 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 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.
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(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, 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 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 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(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, 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 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.