Skip to content
Last updated

no-identical-paths

Ensures there are no identical paths in your API descriptions even when they have different path parameter names.

OASCompatibility
2.0✅
3.0✅
3.1✅

According to the OpenAPI specification:

The following paths are considered identical and invalid:

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

Root
Paths

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

OptionTypeDescription
severitystringPossible 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

Resources

 
Next page