no-request-body-parameter-for-get-http-method
Overview
This rule belongs to the io-docs-validation ruleset and states that:
If a method in an I/O Docs document has httpMethod set as GET, it must not define a request section as such methods do not expect a body and, therefore, all related information will be ignored automatically during import/transformations in APIMatic.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | GET HTTP method has a request defined. |
| Code | IODOCS_V101 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Methods |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | io docs semantic validation request body get method resource |
Suggested Fixes
- Remove the
requestsection from the method definition if thehttpMethodis set asGET.