Skip to main content

operation-parameter-redefines-path-object-parameter

Overview​

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

If a parameter is defined under the parameters property of the Operation Object as well as in the Path Item Object level parameters, the Operation Object level parameter definition will override the definition found in the Path Item Object parameters but will not remove it.

PropertyValue
EnabledYes
Maximum SeverityInformation
MessageOperation Object level parameter is also defined in the Path Item Object and will override the definition found in the Path Item Object.
CodeOPENAPI3STANDARDS_L040
TypeLinting
Rule SystemSemantic
Broad CategoryOperations
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic linting parameter operation path

Suggested Fixes​

  • If you do not intend to override any Path Item Object level parameter or the parameter definitions at Path Item level and Operation level are exactly the same, remove the Operation Object level parameter's entry from the parameters property definition.
  • Parameter names are compared in a case-sensitive manner.

For More Information​