operation-operationId-url-safe

Requires the operationId value to be URL safe.

OAS Compatibility
2.0
3.0
3.1

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

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

An example configuration:

Copy
Copied
styleguide:
  rules:
    operation-operationId-url-safe: error

Examples

Given this configuration:

Copy
Copied
styleguide:
  rules:
    operation-operationId-url-safe: error

Example of an incorrect operation:

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

Example of a correct operation:

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

Related rules

Resources