Last updated

path-excludes-patterns

Disallow patterns from paths.

OASCompatibility
2.0✅
3.0✅
3.1✅

API design principles

The no-http-verbs-in-paths rule is pre-built for a very specific set of patterns. This rule is the general Swiss army knife version. If you absolutely know something should not be in the path (for example foo), then add the pattern to prevent it.

Some common things to check using this rule: other common CRUD verbs, bad words, and internal code or terminology.

Configuration

OptionTypeDescription
severitystringPossible values: off, warn, error. Default off (in recommended configuration).
patterns[string]List of patterns to match. For example, ^\/[a-z].

An example configuration:

rules:
  path-excludes-patterns:
    severity: error
    patterns:
      - ^\/[0-9]

Examples

Given this configuration:

rules:
  path-excludes-patterns:
    severity: error
    patterns:
      - ^\/[0-9]

Example of an incorrect path:

paths:
  /1customers/{id}:
    post:
      parameters:
        - name: id
          in: path
          required: true

Example of a correct path:

paths:
  /customers/{id}:
    post:
      parameters:
        - name: id
          in: path
          required: true

Resources