Ensures there are no identical paths in your API descriptions even when they have different path parameter names.
| OAS | Compatibility |
|---|---|
| 2.0 | ✅ |
| 3.0 | ✅ |
| 3.1 | ✅ |
| 3.2 | ✅ |
According to the OpenAPI specification:
The following paths are considered identical and invalid:
/pets/{petId} /pets/{name}
Identical paths leads to uncertainty and doubt for both API producers and consumers. Ambiguity surrounds us. Minimize it in APIs to make them as easy as possible to use.
| Option | Type | Description |
|---|---|---|
| severity | string | Possible values: off, warn, error. Default error (in recommended configuration). |
An example configuration:
rules:
no-identical-paths: errorGiven this configuration:
rules:
no-identical-paths: errorExample of incorrect paths:
paths:
/pets/{petId}:
$ref: ./paths/petById.yaml
/pets/{name}:
$ref: ./paths/petByName.yamlExample of correct paths:
paths:
/pets/{petId}:
$ref: ./paths/petById.yaml
/pet-names/{name}:
$ref: ./paths/petByName.yaml