Skip to main content

no-invalid-parameter-examples

Validates parameter example candidates against the resolved parameter schema.

AttributeValue
CategoryExamples
MaturityBronze
Starter–LenientOff
Recommended–StrictWarning
CompleteError

See it fail

- in: query
name: limit
schema: { type: integer }
example: ten

Fix it

Use example: 10, or change schema when text is intended.

Options

Set allowAdditionalProperties: true when object examples may contain undeclared fields. Default: false.

Nearby: no-invalid-media-type-examples, no-invalid-schema-examples.