valid-custom-type-field-primitive-type
Overview
This rule belongs to the apimatic-preliminary-validation ruleset and states that:
Some types like "File", "Void" and "Dynamic" are not applicable to model fields and, therefore, should not be used in field definitions.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Type specified is not applicable to model fields. |
| Code | APIMATICPRE_V511 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Global Types/Models |
| Products Impacted | Code Generation, Developer Experience Portal, API Transformer |
| Tags | preliminary checks validation apimatic type primitive type scalar type field model property custom type complex model |
Suggested Fixes
- Use only valid and supported primitive types for model fields e.g. "Binary" instead of "File", "Object" instead of "Dynamic".