redocly-cli/docs/rules/no-identical-paths.md

slug

slug
/docs/cli/rules/no-identical-paths

no-identical-paths

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	✅

According to the OpenAPI specification:

The following paths are considered identical and invalid:

 /pets/{petId}
 /pets/{name}

flowchart TD

Root ==> Paths
style Paths fill:#codaf9,stroke:#0044d4,stroke-width:5px

API design principles

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.

Configuration

Option	Type	Description
severity	string	Possible values: off, warn, error. Default error (in recommended configuration).

An example configuration:

rules:
  no-identical-paths: error

Examples

Given this configuration:

rules:
  no-identical-paths: error

Example of incorrect paths:

paths:
  /pets/{petId}:
    $ref: ./paths/petById.yaml
  /pets/{name}:
    $ref: ./paths/petByName.yaml

Example of correct paths:

paths:
  /pets/{petId}:
    $ref: ./paths/petById.yaml
  /pet-names/{name}:
    $ref: ./paths/petByName.yaml

Related rules

• no-ambiguous-paths
• spec

Resources

• Rule source
• Paths object docs