Disallow invalid parameter examples.
| OAS | Compatibility |
|---|---|
| 2.0 | ✅ |
| 3.0 | ✅ |
| 3.1 | ✅ |
| 3.2 | ✅ |
If your parameter schema and example conflict, there is a problem in the definition of the schema or the example. Solve it before you ship it.
| Option | Type | Description |
|---|---|---|
| severity | string | Possible values: off, warn, error. Default warn. |
| allowAdditionalProperties | boolean | Determines if additional properties are allowed in examples. Default false. |
rules:
no-invalid-parameter-examples:
severity: error
allowAdditionalProperties: falseGiven the following configuration:
rules:
no-invalid-parameter-examples:
severity: error
allowAdditionalProperties: falseExample of incorrect parameter example:
paths:
/results:
get:
summary: Search Chess Results
operationId: searchChessResult
parameters:
- name: username
in: query
schema:
type: string
maxLength: 15
description: Value to query the chess results against usernames
example: ThisUsernameIsTooLongExample of correct parameter example:
paths:
/results:
get:
summary: Search Chess Results
operationId: searchChessResult
parameters:
- name: username
in: query
schema:
type: string
maxLength: 10
description: Value to query the chess results against usernames
example: ellaIn OpenAPI 3.2, provide the structured example in dataValue, which is validated against the schema the same way value is. When dataValue is present, value must be absent (see spec-example-values).
Example of an incorrect dataValue:
paths:
/results:
get:
summary: Search Chess Results
operationId: searchChessResult
parameters:
- name: rating
in: query
schema:
type: integer
examples:
grandmaster:
dataValue: '2500'This example produces an error because the rating is a string instead of an integer.
Example of a correct dataValue:
paths:
/results:
get:
summary: Search Chess Results
operationId: searchChessResult
parameters:
- name: rating
in: query
schema:
type: integer
examples:
grandmaster:
dataValue: 2500