Skip to main content

parameter-example-overrides-schema-example

Overview​

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

An example for a parameter can be provided in multiple ways: either directly in the Parameter Object using the examples/example property or within the parameter level schema definition using the example property. If an example is provided at both levels, the Parameter Object level example will override the Schema Object level example.

PropertyValue
EnabledYes
Maximum SeverityInformation
MessageParameter Object level example found that overrides the example present in the parameter's schema definition.
CodeOPENAPI3STANDARDS_V100
TypeValidation
Rule SystemSemantic
Broad CategoryParameters
Products ImpactedAPI Transformer, Developer Experience Portal
Tagsopenapi3 openapi standards semantic validation example parameter schema

Suggested Fixes​

  • If the parameter schema level example adds no new example value as compared to the one at Parameter Object level, remove the schema level example property.

For More Information​