@Documented @Target(value=PARAMETER) @Retention(value=RUNTIME) @Inherited @Deprecated public @interface Parameter
@MethodSwagger.parameters()
to identify
content and header descriptions on specific method requests.
Modifier and Type | Optional Element and Description |
---|---|
String |
_default
Deprecated.
Declares the value of the parameter that the server will use if none is provided.
|
boolean |
allowEmptyValue
Deprecated.
Sets the ability to pass empty-valued parameters.
|
String |
collectionFormat
Deprecated.
Determines the format of the array if type array is used.
|
String |
description
Deprecated.
Parameter description (e.g.
|
String |
format
Deprecated.
The extending format for the previously mentioned
type . |
String |
in
Deprecated.
The location of the parameter.
|
String |
items
Deprecated.
Required if
type is |
String |
name
Deprecated.
The name of the parameter (e.g.
|
boolean |
required
Deprecated.
Determines whether this parameter is mandatory.
|
String |
schema
Deprecated.
The schema defining the type used for the body parameter.
|
String |
type
Deprecated.
The type of the parameter.
|
public abstract String _default
For example a "count" to control the number of results per page might default to 100 if not supplied by the
client in the request.
(Note: "default" has no meaning for required parameters.)
See
http://json-schema.org/latest/json-schema-validation.html#anchor101.
Unlike JSON Schema this value MUST conform to the defined type
for this parameter.
public abstract boolean allowEmptyValue
This is valid only for either query
or formData
parameters and allows you to send a
parameter with a name only or an empty value.
Default value is
public abstract String collectionFormat
Possible values are:
in
public abstract String description
A brief description of the parameter. This could contain examples of use. GFM syntax can be used for rich text representation.
The default value pulls the description from the description
entry in the servlet resource bundle.
(e.g.
public abstract String format
type
.
See Data Type Formats for further details.
public abstract String items
type
is Describes the type of items in the array.
See Items Object for further details.
public abstract String name
Parameter names are case sensitive.
If in
is path
field in the Paths Object.
See Path Templating for further
information.
For all other cases, the name corresponds to the parameter name used based on the in
property.
public abstract boolean required
If the parameter is in
public abstract String schema
Only applicable for in
of type
The schema is a JSON object specified here.
public abstract String type
The value MUST be one of
Copyright © 2018 Apache. All rights reserved.