Description
For listing the types of information items on front-end input parameters.
Node name
RequestParameter.
Subnodes
| Name | Type | Description |
|---|---|---|
| ApiParameterName | String | Parameter name. |
| Location | String | Parameter location; values: BODY, HEAD, QUERY, and PATH. |
| ParameterType | String | Parameter type; values: String (character type), Int (integer type), Long (long integer type), Float (single-precision floating-point type), Double (double-precision floating-point type), and Boolean (Boolean type). |
| Required | String | Required or not; values: REQUIRED (required) and OPTIONAL (optional). |
| DefaultValue | String | Default value. |
| DemoValue | String | Example. |
| MaxValue | Long | Maximum parameter value when ParameterType is set to Int, Long, Float, or Double. |
| MinValue | Long | Minimum parameter value when ParameterType is set to Int, Long, Float, or Double. |
| MaxLength | Long | Maximum parameter length when ParameterType is set to String. |
| MinLength | Long | Minimum parameter length when ParameterType is set to String. |
| RegularExpression | String | Parameter validation (regular expression) when ParameterType is set to String. |
| JsonScheme | String | JSON validation (JSON Schema) when ParameterType is set to String. |
| EnumValue | String | Hash value that can be input when ParameterType is set to Int, Long, Float, Double, or String. Different values must be separated by a comma, for example, 1, 2, 3, 4, 9 or A, B, C, E, F. |
| DocShow | String | Document visibility; values: PUBLIC and PRIVATE. |
| DocOrder | Integer | Order in a document. |
| Description | String | Parameter description. |