RequestParameter

ApiParameterName

String

The parameter name.

Location

String

The location of the parameter. Valid values are BODY, HEAD, QUERY, and PATH.

ParameterType

String

The data type of the parameter. Valid values are String, Int, Long, Float, Double, and Boolean. These values represent string, integer, long, single-precision floating-point, double-precision floating-point, and Boolean types, respectively.

Required

String

Specifies whether the parameter is required. Valid values are REQUIRED and OPTIONAL. REQUIRED indicates that the parameter is required. OPTIONAL indicates that the parameter is not required.

DefaultValue

String

The default value.

DemoValue

String

Example

MaxValue

Long

The maximum value of the parameter. This applies when ParameterType is set to Int, Long, Float, or Double.

MinValue

Long

The minimum value of the parameter. This applies when ParameterType is set to Int, Long, Float, or Double.

MaxLength

Long

The maximum length of the parameter. This applies when ParameterType is set to String.

MinLength

Long

The minimum length of the parameter. This applies when ParameterType is set to String.

RegularExpression

String

The regular expression used for validation. This applies when ParameterType is set to String.

JsonScheme

String

The JSON Schema used for validation. This applies when ParameterType is set to String.

EnumValue

String

The enumerated values that are allowed. Separate multiple values with commas. This applies when ParameterType is Int, Long, Float, Double, or String. Examples: 1,2,3,4,9 or A,B,C,E,F.

DocShow

String

The visibility of the parameter in the documentation. Valid values are PUBLIC and PRIVATE.

DocOrder

Integer

Document order

Description

String

The description of the parameter.