Skip to main content

valid-callback-url-expression

Overview​

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

Callback Object keys must be valid runtime expressions as defined by the OpenAPI specification. The expression is evaluated at runtime to determine the URL for the callback request. The expression must conform to the runtime expression ABNF grammar defined in the specification.

PropertyValue
EnabledYes
Maximum SeverityError
MessageThe callback URL expression is not a valid runtime expression.
CodeOPENAPI3STANDARDS_V216
TypeValidation
Rule SystemSemantic
Broad CategoryCallbacks
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic validation callbacks expression runtime url

Suggested Fixes​

  • Ensure the callback URL expression follows the runtime expression format: $url, $method, $statusCode, $request.header.name, $request.query.name, $request.path.name, $request.body#/pointer, $response.header.name, or $response.body#/pointer.
  • Check for typos or invalid characters in the runtime expression.

For More Information​