Skip to main content

valid-operation-ref

Overview

This rule belongs to the openapi-v3-syntax-validation ruleset and states that:

operationRef must be a valid relative or absolute URI reference to an OAS operation. In the use of operationRef, the escaped forward-slash is necessary when using JSON references.

PropertyValue
EnabledYes
Maximum SeverityError
MessageoperationRef value is not a valid URI.
CodeOPENAPI3SYNTAX_V100
TypeValidation
Rule SystemSyntax
Broad CategoryLinks
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi syntax validation uri operation ref operation link

Suggested Fixes

  • Ensure that the value of operationRef is a valid URI.
  • Ensure that the value of operationRef is not null or empty.
  • operationRef can either be a relative or absolute URI.

For More Information