valid-response-primitive-type
Overview
This rule belongs to the apimatic-preliminary-validation ruleset and states that:
Some types like "File" are not applicable to responses and, therefore, should not be used in response definitions.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Type specified is not applicable to responses. |
| Code | APIMATICPRE_V309 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Endpoint Responses |
| Products Impacted | Code Generation, Developer Experience Portal, API Transformer |
| Tags | preliminary checks validation apimatic type primitive type scalar type response endpoint |
Suggested Fixes
- Use only valid and supported primitive types for responses e.g. "Binary" instead of "File".