Skip to content
Last updated

operation-operationId-url-safe

Requires the operationId value to be URL safe.

OASCompatibility
2.0✅
3.0✅
3.1✅
3.2✅

API design principles

The operationId is used by tooling to identify operations (which are otherwise done through scary looking JSON pointers). Some tooling may use it in a URL path. This rule makes it possible to use the operationId in URLs without any transformation of the operationId.

This rule is unopinionated.

Configuration

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

An example configuration:

rules:
  operation-operationId-url-safe: error

Examples

Given this configuration:

rules:
  operation-operationId-url-safe: error

Example of an incorrect operation:

paths:
  /cars:
    get:
      operationId: Car<>Wash
      # ...

Example of a correct operation:

paths:
  /cars:
    get:
      operationId: CarWash
      # ...

Resources

 
Next page