valid-parameter-primitive-type
Overview
This rule belongs to the apimatic-post-processing-validation ruleset and states that:
Some types like "Binary", "Void" and "Dynamic" are not applicable to parameters and, therefore, will be auto-converted to their equivalent valid types.
| Property | Value |
|---|---|
| Enabled | No |
| Maximum Severity | Warning |
| Message | The current type specified is not applicable to parameters and has been converted to a valid equivalent type. |
| Code | APIMATICPOSTPROCESS_V251 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Endpoint Parameters |
| Products Impacted | Code Generation, Developer Experience Portal, API Transformer |
| Tags | apimatic postprocessing validation type primitive type scalar type parameter endpoint |
Suggested Fixes
- Use only valid and supported primitive types for parameters e.g. String, Number, Long, Precision, Boolean, etc.
- Use type "File" instead of "Binary".
- Use type "Object" instead of "Dynamic".
- Use the Optional or Nullable flags to show that parameter can have no or null value.