Skip to main content

required-parameter-location

Overview​

This rule belongs to the openapi-v3-standards-validation ruleset and states that:

The Parameter Object must specify a location for the parameter using the in property. The location identifies where the parameter needs to be sent in the request and must not be null or empty. Possible values are 'query', 'header', 'path' or 'cookie'.

PropertyValue
EnabledYes
Maximum SeverityError
MessageRequired in property in Parameter Object is missing.
CodeOPENAPI3STANDARDS_V076
TypeValidation
Rule SystemSemantic
Broad CategoryParameters
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic validation location parameter

Suggested Fixes​

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

For More Information​