Skip to content
Last updated

path-parameters-defined

Requires all path template variables are defined as path parameters.

OASCompatibility
2.0✅
3.0✅
3.1✅

API design principles

You declared them? Now define them. This rule verifies the path parameters are defined.

Configuration

OptionTypeDescription
severitystringPossible values: off, warn, error. Default error (in recommended configuration).

An example configuration:

rules:
  path-parameters-defined: error

Examples

Given this configuration:

rules:
  path-parameters-defined: error

Example of an incorrect path:

paths:
  /customers/{id}:
    post:
      parameters:
        - name: filter
          in: query

Example of a correct path:

paths:
  /customers/{id}:
    post:
      parameters:
        - name: id
          in: path
          required: true
          description: The customer's ID.

Resources

path-segment-plural