Skip to main content

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.

PropertyValue
EnabledYes
Maximum SeverityError
MessageRequired paramType property in Parameter Object is missing.
CodeSWAGGER1_V601
TypeValidation
Rule SystemSemantic
Broad CategoryParameters
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsswagger1 swagger semantic validation type location parameter

Suggested Fixes

  • Add missing paramType property in the Parameter object.
  • Make sure that the paramType property is not null or empty.
  • Make sure that the value of the paramType property is one of the following values: query, header, path, form or body. The values are case-sensitive.

For More Information