Skip to main content

valid-path-parameter-style

Overview​

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

For path parameters, only the following styles are applicable: matrix, label, or simple. Rest will be treated as invalid.

PropertyValue
EnabledYes
Maximum SeverityError
MessageThe current value of style is not applicable to path parameters.
CodeOPENAPI3STANDARDS_V088
TypeValidation
Rule SystemSemantic
Broad CategoryParameters
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic validation style serialization path parameter

Suggested Fixes​

  • Parameter style value is compared in a case-sensitive manner.
  • Ensure that you are not using a style value that is not supported for path parameters e.g. form, spaceDelimited, pipeDelimited or deepObject.
  • Ensure that the value for style is not null or empty.

For More Information​