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:
rules:
operation-operationId-url-safe: errorExamples
Given this configuration:
rules:
operation-operationId-url-safe: errorExample of an incorrect operation:
paths:
/cars:
get:
operationId: Car<>Wash
# ...Example of a correct operation:
paths:
/cars:
get:
operationId: CarWash
# ...Related rules
Resources
- Rule source
- Operation object docs
- Consider using configurable rules for more specific rules for
operationIds such as length, casing, and pattern enforcement.