public class RequestParametersSnippet extends AbstractParametersSnippet
Snippet
that documents the request parameters supported by a RESTful
resource.
Request parameters are sent as part of the query string or as POSTed form data.
Modifier | Constructor and Description |
---|---|
protected |
RequestParametersSnippet(List<ParameterDescriptor> descriptors)
Creates a new
RequestParametersSnippet that will document the request's
parameters using the given descriptors . |
protected |
RequestParametersSnippet(List<ParameterDescriptor> descriptors,
Map<String,Object> attributes)
Creates a new
RequestParametersSnippet that will document the request's
parameters using the given descriptors . |
Modifier and Type | Method and Description |
---|---|
protected Set<String> |
extractActualParameters(Operation operation) |
protected void |
verificationFailed(Set<String> undocumentedParameters,
Set<String> missingParameters) |
createModel, createModelForDescriptor, getFieldDescriptors, verifyParameterDescriptors
document, getAttributes, getSnippetName
protected RequestParametersSnippet(List<ParameterDescriptor> descriptors)
RequestParametersSnippet
that will document the request's
parameters using the given descriptors
.descriptors
- the parameter descriptorsprotected RequestParametersSnippet(List<ParameterDescriptor> descriptors, Map<String,Object> attributes)
RequestParametersSnippet
that will document the request's
parameters using the given descriptors
. The given attributes
will
be included in the model during template rendering.descriptors
- the parameter descriptorsattributes
- the additional attributesprotected void verificationFailed(Set<String> undocumentedParameters, Set<String> missingParameters)
verificationFailed
in class AbstractParametersSnippet
protected Set<String> extractActualParameters(Operation operation)
extractActualParameters
in class AbstractParametersSnippet