valid-parameter-default-value-type
Overview
This rule belongs to the swagger-v2-standards-validation ruleset and states that:
Default value must conform to the defined type for this parameter, which is defined by the type property.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Default value does not conform to the defined type for this parameter. |
| Code | SWAGGER20STANDARDS_V112 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Parameters |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | swagger2 swagger standards semantic validation default value default parameter type |
Suggested Fixes
- If an array is expected, ensure that your value is surrounded by square brackets [ and ].
- If an array is not expected, ensure that your value contains a single item only and is not surrounded by square brackets [ and ].
- If a numeric value is expected, ensure that your value is a valid number and it is not surrounded by single or double quotes.
- If a string value is expected, ensure that it is escaped properly and surrounded by quotes if necessary.
- If an object is expected, ensure that your value is a key-value map.
- If a boolean value is expected, ensure that your value is either true or false only and is not surrounded by quotes.