required-parameter-param-type
Overview
This rule belongs to the swagger-v1-validation ruleset and states that:
The Parameter Object must specify the type of the parameter (i.e. location of the parameter in the request) using the paramType property. The value of this property must be one of the following: query, header, path, form or body. If a value is not provided, query will be assumed by default automatically during import/transformations into APIMatic.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Required paramType property in Parameter Object is missing. |
| Code | SWAGGER1_V601 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Parameters |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | swagger1 swagger semantic validation type location parameter |
Suggested Fixes
- Add missing
paramTypeproperty in the Parameter object. - Make sure that the
paramTypeproperty is not null or empty. - Make sure that the value of the
paramTypeproperty is one of the following values:query,header,path,formorbody. The values are case-sensitive.