Uses of Class
org.springframework.restdocs.request.RequestPartDescriptor

Packages that use RequestPartDescriptor

Package	Description
org.springframework.restdocs.request	Documenting query and path parameters of requests sent to a RESTful API.

Uses of RequestPartDescriptor in org.springframework.restdocs.request

Methods in org.springframework.restdocs.request that return RequestPartDescriptor

Modifier and Type	Method and Description
RequestPartDescriptor	RequestPartDescriptor.optional() Marks the request part as optional.
static RequestPartDescriptor	RequestDocumentation.partWithName(java.lang.String name) Creates a RequestPartDescriptor that describes a request part with the given name.

Methods in org.springframework.restdocs.request with parameters of type RequestPartDescriptor

Modifier and Type	Method and Description
RequestPartsSnippet	RequestPartsSnippet.and(RequestPartDescriptor... additionalDescriptors) Returns a new RequestPartsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
static RequestPartsSnippet	RequestDocumentation.relaxedRequestParts(java.util.Map<java.lang.String,java.lang.Object> attributes, RequestPartDescriptor... descriptors) Returns a Snippet that will document the parts from the API operation's request.
static RequestPartsSnippet	RequestDocumentation.relaxedRequestParts(RequestPartDescriptor... descriptors) Returns a Snippet that will document the parts from the API operation's request.
static RequestPartsSnippet	RequestDocumentation.requestParts(java.util.Map<java.lang.String,java.lang.Object> attributes, RequestPartDescriptor... descriptors) Returns a Snippet that will document the parts from the API operation's request.
static RequestPartsSnippet	RequestDocumentation.requestParts(RequestPartDescriptor... descriptors) Returns a Snippet that will document the parts from the API operation's request.

Method parameters in org.springframework.restdocs.request with type arguments of type RequestPartDescriptor

Modifier and Type	Method and Description
RequestPartsSnippet	RequestPartsSnippet.and(java.util.List<RequestPartDescriptor> additionalDescriptors) Returns a new RequestPartsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
static RequestPartsSnippet	RequestDocumentation.relaxedRequestParts(java.util.List<RequestPartDescriptor> descriptors) Returns a Snippet that will document the parts from the API operation's request.
static RequestPartsSnippet	RequestDocumentation.relaxedRequestParts(java.util.Map<java.lang.String,java.lang.Object> attributes, java.util.List<RequestPartDescriptor> descriptors) Returns a Snippet that will document the parts from the API operation's request.
static RequestPartsSnippet	RequestDocumentation.requestParts(java.util.List<RequestPartDescriptor> descriptors) Returns a Snippet that will document the parts from the API operation's request.
static RequestPartsSnippet	RequestDocumentation.requestParts(java.util.Map<java.lang.String,java.lang.Object> attributes, java.util.List<RequestPartDescriptor> descriptors) Returns a Snippet that will document the parts from the API operation's request.

Constructor parameters in org.springframework.restdocs.request with type arguments of type RequestPartDescriptor

Constructor and Description
RequestPartsSnippet(java.util.List<RequestPartDescriptor> descriptors) Creates a new RequestPartsSnippet that will document the request's parts using the given descriptors.
RequestPartsSnippet(java.util.List<RequestPartDescriptor> descriptors, boolean ignoreUndocumentedParts) Creates a new RequestPartsSnippet that will document the request's parts using the given descriptors.
RequestPartsSnippet(java.util.List<RequestPartDescriptor> descriptors, java.util.Map<java.lang.String,java.lang.Object> attributes) Creates a new RequestPartsSnippet that will document the request's parts using the given descriptors.
RequestPartsSnippet(java.util.List<RequestPartDescriptor> descriptors, java.util.Map<java.lang.String,java.lang.Object> attributes, boolean ignoreUndocumentedParts) Creates a new RequestPartsSnippet that will document the request's parts using the given descriptors.