mirror of
https://github.com/LukeHagar/redocly-cli.git
synced 2025-12-06 20:57:44 +00:00
79 lines
1.8 KiB
Markdown
79 lines
1.8 KiB
Markdown
---
|
|
slug: /docs/cli/rules/operation-parameters-unique
|
|
---
|
|
|
|
# operation-parameters-unique
|
|
|
|
Verifies parameters are unique for any given operation.
|
|
|
|
| OAS | Compatibility |
|
|
| --- | ------------- |
|
|
| 2.0 | ✅ |
|
|
| 3.0 | ✅ |
|
|
| 3.1 | ✅ |
|
|
|
|
## API design principles
|
|
|
|
Identical twins are the topic of social research.
|
|
And some interesting studies have been published over the years that used identical twins in their studies.
|
|
Identical parameters, on the other hand, are a design mistake.
|
|
Solve it before you ship it.
|
|
|
|
## Configuration
|
|
|
|
| Option | Type | Description |
|
|
| -------- | ------ | ------------------------------------------------------------------------------------------ |
|
|
| severity | string | Possible values: `off`, `warn`, `error`. Default `error` (in `recommended` configuration). |
|
|
|
|
An example configuration:
|
|
|
|
```yaml
|
|
rules:
|
|
operation-parameters-unique: error
|
|
```
|
|
|
|
## Examples
|
|
|
|
Given this configuration:
|
|
|
|
```yaml
|
|
rules:
|
|
operation-parameters-unique: error
|
|
```
|
|
|
|
Example of an **incorrect** operation:
|
|
|
|
```yaml
|
|
paths:
|
|
/cars:
|
|
get:
|
|
parameters:
|
|
- name: filter
|
|
in: query
|
|
- name: filter
|
|
in: query
|
|
```
|
|
|
|
Example of a **correct** operation:
|
|
|
|
```yaml
|
|
paths:
|
|
/cars:
|
|
get:
|
|
parameters:
|
|
- name: filter
|
|
in: query
|
|
- name: another-filter
|
|
in: query
|
|
```
|
|
|
|
## Related rules
|
|
|
|
- [path-parameters-defined](./path-parameters-defined.md)
|
|
|
|
## Resources
|
|
|
|
- [Rule source](https://github.com/Redocly/redocly-cli/blob/main/packages/core/src/rules/common/operation-parameters-unique.ts)
|
|
- [Operation object docs](https://redocly.com/docs/openapi-visual-reference/operation/)
|
|
- [Parameter object docs](https://redocly.com/docs/openapi-visual-reference/parameter/)
|