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

Packages that use ParameterDescriptor

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

Uses of ParameterDescriptor in org.springframework.restdocs.request

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

Modifier and Type	Method	Description
final ParameterDescriptor	ParameterDescriptor.optional()	Marks the parameter as optional.
static ParameterDescriptor	RequestDocumentation.parameterWithName(String name)	Creates a ParameterDescriptor that describes a request or path parameter with the given name.

Methods in org.springframework.restdocs.request that return types with arguments of type ParameterDescriptor

Modifier and Type	Method	Description
protected final Map<String,ParameterDescriptor>	AbstractParametersSnippet.getParameterDescriptors()	Returns a Map of ParameterDescriptors that will be used to generate the documentation key by their getName().

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

Modifier and Type	Method	Description
FormParametersSnippet	FormParametersSnippet.and(ParameterDescriptor... additionalDescriptors)	Returns a new FormParametersSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
final PathParametersSnippet	PathParametersSnippet.and(ParameterDescriptor... additionalDescriptors)	Returns a new PathParametersSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
QueryParametersSnippet	QueryParametersSnippet.and(ParameterDescriptor... additionalDescriptors)	Returns a new QueryParametersSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
protected Map<String,Object>	AbstractParametersSnippet.createModelForDescriptor(ParameterDescriptor descriptor)	Returns a model for the given descriptor.
static FormParametersSnippet	RequestDocumentation.formParameters(Map<String,Object> attributes, ParameterDescriptor... descriptors)	Returns a Snippet that will document the form parameters from the API operation's request.
static FormParametersSnippet	RequestDocumentation.formParameters(ParameterDescriptor... descriptors)	Returns a Snippet that will document the form parameters from the API operation's request.
static PathParametersSnippet	RequestDocumentation.pathParameters(Map<String,Object> attributes, ParameterDescriptor... descriptors)	Returns a Snippet that will document the path parameters from the API operation's request.
static PathParametersSnippet	RequestDocumentation.pathParameters(ParameterDescriptor... descriptors)	Returns a Snippet that will document the path parameters from the API operation's request.
static QueryParametersSnippet	RequestDocumentation.queryParameters(Map<String,Object> attributes, ParameterDescriptor... descriptors)	Returns a Snippet that will document the query parameters from the API operation's request.
static QueryParametersSnippet	RequestDocumentation.queryParameters(ParameterDescriptor... descriptors)	Returns a Snippet that will document the query parameters from the API operation's request.
static FormParametersSnippet	RequestDocumentation.relaxedFormParameters(Map<String,Object> attributes, ParameterDescriptor... descriptors)	Returns a Snippet that will document the form parameters from the API operation's request.
static FormParametersSnippet	RequestDocumentation.relaxedFormParameters(ParameterDescriptor... descriptors)	Returns a Snippet that will document the form parameters from the API operation's request.
static PathParametersSnippet	RequestDocumentation.relaxedPathParameters(Map<String,Object> attributes, ParameterDescriptor... descriptors)	Returns a Snippet that will document the path parameters from the API operation's request.
static PathParametersSnippet	RequestDocumentation.relaxedPathParameters(ParameterDescriptor... descriptors)	Returns a Snippet that will document the path parameters from the API operation's request.
static QueryParametersSnippet	RequestDocumentation.relaxedQueryParameters(Map<String,Object> attributes, ParameterDescriptor... descriptors)	Returns a Snippet that will document the query parameters from the API operation's request.
static QueryParametersSnippet	RequestDocumentation.relaxedQueryParameters(ParameterDescriptor... descriptors)	Returns a Snippet that will document the query parameters from the API operation's request.

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

Modifier and Type	Method	Description
FormParametersSnippet	FormParametersSnippet.and(List<ParameterDescriptor> additionalDescriptors)	Returns a new FormParametersSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
final PathParametersSnippet	PathParametersSnippet.and(List<ParameterDescriptor> additionalDescriptors)	Returns a new PathParametersSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
QueryParametersSnippet	QueryParametersSnippet.and(List<ParameterDescriptor> additionalDescriptors)	Returns a new QueryParametersSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
static FormParametersSnippet	RequestDocumentation.formParameters(List<ParameterDescriptor> descriptors)	Returns a Snippet that will document the form parameters from the API operation's request.
static FormParametersSnippet	RequestDocumentation.formParameters(Map<String,Object> attributes, List<ParameterDescriptor> descriptors)	Returns a Snippet that will document the form parameters from the API operation's request.
static PathParametersSnippet	RequestDocumentation.pathParameters(List<ParameterDescriptor> descriptors)	Returns a Snippet that will document the path parameters from the API operation's request.
static PathParametersSnippet	RequestDocumentation.pathParameters(Map<String,Object> attributes, List<ParameterDescriptor> descriptors)	Returns a Snippet that will document the path parameters from the API operation's request.
static QueryParametersSnippet	RequestDocumentation.queryParameters(List<ParameterDescriptor> descriptors)	Returns a Snippet that will document the query parameters from the API operation's request.
static QueryParametersSnippet	RequestDocumentation.queryParameters(Map<String,Object> attributes, List<ParameterDescriptor> descriptors)	Returns a Snippet that will document the query parameters from the API operation's request.
static FormParametersSnippet	RequestDocumentation.relaxedFormParameters(List<ParameterDescriptor> descriptors)	Returns a Snippet that will document the form parameters from the API operation's request.
static FormParametersSnippet	RequestDocumentation.relaxedFormParameters(Map<String,Object> attributes, List<ParameterDescriptor> descriptors)	Returns a Snippet that will document the form parameters from the API operation's request.
static PathParametersSnippet	RequestDocumentation.relaxedPathParameters(List<ParameterDescriptor> descriptors)	Returns a Snippet that will document the path parameters from the API operation's request.
static PathParametersSnippet	RequestDocumentation.relaxedPathParameters(Map<String,Object> attributes, List<ParameterDescriptor> descriptors)	Returns a Snippet that will document the path parameters from the API operation's request.
static QueryParametersSnippet	RequestDocumentation.relaxedQueryParameters(List<ParameterDescriptor> descriptors)	Returns a Snippet that will document the query parameters from the API operation's request.
static QueryParametersSnippet	RequestDocumentation.relaxedQueryParameters(Map<String,Object> attributes, List<ParameterDescriptor> descriptors)	Returns a Snippet that will document the query parameters from the API operation's request.

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

Modifier	Constructor	Description
protected	AbstractParametersSnippet(String snippetName, List<ParameterDescriptor> descriptors, Map<String,Object> attributes, boolean ignoreUndocumentedParameters)	Creates a new AbstractParametersSnippet that will produce a snippet with the given snippetName that will document parameters using the given descriptors.
protected	FormParametersSnippet(List<ParameterDescriptor> descriptors)	Creates a new FormParametersSnippet that will document the request's form parameters using the given descriptors.
protected	FormParametersSnippet(List<ParameterDescriptor> descriptors, boolean ignoreUndocumentedParameters)	Creates a new FormParametersSnippet that will document the request's form parameters using the given descriptors.
protected	FormParametersSnippet(List<ParameterDescriptor> descriptors, Map<String,Object> attributes)	Creates a new FormParametersSnippet that will document the request's form parameters using the given descriptors.
protected	FormParametersSnippet(List<ParameterDescriptor> descriptors, Map<String,Object> attributes, boolean ignoreUndocumentedParameters)	Creates a new FormParametersSnippet that will document the request's form parameters using the given descriptors.
protected	PathParametersSnippet(List<ParameterDescriptor> descriptors)	Creates a new PathParametersSnippet that will document the request's path parameters using the given descriptors.
protected	PathParametersSnippet(List<ParameterDescriptor> descriptors, boolean ignoreUndocumentedParameters)	Creates a new PathParametersSnippet that will document the request's path parameters using the given descriptors.
protected	PathParametersSnippet(List<ParameterDescriptor> descriptors, Map<String,Object> attributes)	Creates a new PathParametersSnippet that will document the request's path parameters using the given descriptors.
protected	PathParametersSnippet(List<ParameterDescriptor> descriptors, Map<String,Object> attributes, boolean ignoreUndocumentedParameters)	Creates a new PathParametersSnippet that will document the request's path parameters using the given descriptors.
protected	QueryParametersSnippet(List<ParameterDescriptor> descriptors)	Creates a new QueryParametersSnippet that will document the request's query parameters using the given descriptors.
protected	QueryParametersSnippet(List<ParameterDescriptor> descriptors, boolean ignoreUndocumentedParameters)	Creates a new QueryParametersSnippet that will document the request's query parameters using the given descriptors.
protected	QueryParametersSnippet(List<ParameterDescriptor> descriptors, Map<String,Object> attributes)	Creates a new QueryParametersSnippet that will document the request's query parameters using the given descriptors.
protected	QueryParametersSnippet(List<ParameterDescriptor> descriptors, Map<String,Object> attributes, boolean ignoreUndocumentedParameters)	Creates a new QueryParametersSnippet that will document the request's query parameters using the given descriptors.