Skip to main content

required-parameter-name

Overview​

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

The Parameter Object must specify a name for the parameter using the name property. The name is API/service defined and must not be null or empty.

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

Suggested Fixes​

  • Add missing name property in the Parameter object.
  • Make sure that the name property is not null or empty.
  • The name of the parameter must match exactly with the name of the parameter expected by the API. Names may be compared in a case-sensitive manner.

For More Information​