no-body-form-parameters-in-non-body-http-methods
Overview
This rule belongs to the apimatic-preliminary-validation ruleset and states that:
HTTP methods like GET do not support a request body therefore, such endpoints should not contain parameter definitions of format "Body" or "Form".
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Form/Body parameters found in an endpoint which has a HTTP method assigned that does not support these parameters. |
| Code | APIMATICPRE_V203 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Endpoint Parameters |
| Products Impacted | Code Generation, Developer Experience Portal, API Transformer |
| Tags | preliminary checks validation apimatic body form parameter endpoint |
Suggested Fixes
- Remove all parameters, that have the format "Body" or "Form", from the endpoint.
- Change the format of the parameters to a non-body format.