path-parameters-defined

Requires all path template variables are defined as path parameters.

OAS Compatibility
2.0
3.0
3.1

API design principles

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

Configuration

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

An example configuration:

Copy
Copied
styleguide:
  rules:
    path-parameters-defined: error

Examples

Given this configuration:

Copy
Copied
styleguide:
  rules:
    path-parameters-defined: error

Example of an incorrect path:

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

Example of a correct path:

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

Related rules

Resources