Skip to main content

operation-operationId-url-safe

Requires nonblank operationId values to contain only URL-safe characters.

AttributeValue
CategoryOperations
MaturityBaseline
OpenAPISwagger 2.0; OpenAPI 3.0, 3.1, 3.2
Starter–LenientWarning
Recommended–CompleteError

Intent

Safe IDs can be reused in links, generated identifiers, and tooling without escaping surprises.

Flags

An ID containing a character outside letters, digits, and this set:

- . _ ~ : / ? # [ ] @ ! $ & ' ( ) * + , ; =

Does not flag

Missing or blank IDs, or IDs composed only of accepted characters. This rule permits URL punctuation; it does not enforce a naming case.

See it fail

get:
operationId: get payment

The space is not allowed.

Fix it

get:
operationId: getPayment

Configure

profiles:
default:
rules:
extends: [recommended]
override:
operation-operationId-url-safe: warn

Nearby: operation-operationId, operation-operationId-unique.