valid-file-type-parameter-formats
Overview
This rule belongs to the apimatic-preliminary-validation ruleset and states that:
File type can only be used for a parameter with format set as "Body" or "Form".
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | The current parameter location/format does not allow a "File" type to be used. |
| Code | APIMATICPRE_V211 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Endpoint Parameters |
| Products Impacted | Code Generation, Developer Experience Portal, API Transformer |
| Tags | preliminary checks validation apimatic file type body form parameter endpoint |
Suggested Fixes
- Change parameter format to "Body" or "Form".
- Remove the parameter with the invalid format.
- Change parameter type to "String".