operation-operationId-valid-in-url
This rule is going to be re-written. Its behavior will not change, however the current implementation is not satisfactory.
An Operation should always contain
an operationId
. This rule will check the value used is friendly to being used as part of a URL.
Documentation and code generation tools depend on this value being unique and often use it as part of URL paths.
Why did this violation appear?
The operationId
for one or more Operation definitions
is not URL friendly.
Bad example
paths:
/snakes/cakes:
post:
operationId: create^a%snake cake
Good example
paths:
/snakes/cakes:
post:
operationId: createASnakeCake
How do I fix this violation?
Remove any non URL friendly characters from all operationId
definitions.
Spectral Equivalent
The rule is equivalent to operation-operationId-valid-in-url