mirror of
https://github.com/LukeHagar/redocly-cli.git
synced 2025-12-06 20:57:44 +00:00
111 lines
2.7 KiB
Markdown
111 lines
2.7 KiB
Markdown
---
|
|
slug: /docs/cli/rules/no-invalid-parameter-examples
|
|
---
|
|
|
|
# no-invalid-parameter-examples
|
|
|
|
Disallow invalid parameter examples.
|
|
|
|
| OAS | Compatibility |
|
|
| --- | ------------- |
|
|
| 2.0 | ✅ |
|
|
| 3.0 | ✅ |
|
|
| 3.1 | ✅ |
|
|
|
|
```mermaid
|
|
flowchart TD
|
|
|
|
Root ==> Paths --> PathItem --> Operation --> Parameter --> Example
|
|
PathItem --> Parameter
|
|
Parameter --> Schema
|
|
Root ==> components
|
|
|
|
NamedParameter --> Parameter
|
|
|
|
Schema -.compares schema\nto example.- Example
|
|
|
|
subgraph components
|
|
NamedParameter
|
|
end
|
|
|
|
|
|
style Example fill:#codaf9,stroke:#0044d4,stroke-width:5px
|
|
style Schema fill:#codaf9,stroke:#0044d4,stroke-width:5px
|
|
```
|
|
|
|
## API design principles
|
|
|
|
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.
|
|
|
|
## Configuration
|
|
|
|
| Option | Type | Description |
|
|
| ------------------------- | ------- | ----------------------------------------------------------------------------- |
|
|
| severity | string | Possible values: `off`, `warn`, `error`. Default `warn`. |
|
|
| allowAdditionalProperties | boolean | Determines if additional properties are allowed in examples. Default `false`. |
|
|
|
|
```yaml
|
|
rules:
|
|
no-invalid-parameter-examples:
|
|
severity: error
|
|
allowAdditionalProperties: false
|
|
```
|
|
|
|
## Examples
|
|
|
|
Given the following configuration:
|
|
|
|
```yaml
|
|
rules:
|
|
no-invalid-parameter-examples:
|
|
severity: error
|
|
allowAdditionalProperties: false
|
|
```
|
|
|
|
Example of **incorrect** parameter example:
|
|
|
|
```yaml
|
|
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: ThisUsernameIsTooLong
|
|
```
|
|
|
|
Example of **correct** parameter example:
|
|
|
|
```yaml
|
|
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: ella
|
|
```
|
|
|
|
## Related rules
|
|
|
|
- [no-invalid-media-type-examples](./no-invalid-media-type-examples.md)
|
|
- [no-invalid-schema-examples](./no-invalid-schema-examples.md)
|
|
|
|
## Resources
|
|
|
|
- [Rule source](https://github.com/Redocly/redocly-cli/blob/main/packages/core/src/rules/common/no-invalid-parameter-examples.ts)
|
|
- [OpenAPI Parameter docs](https://redocly.com/docs/openapi-visual-reference/parameter/)
|