Skip to main content

valid-callback-key-expression

Overview

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

Callback key is a string used for identifying the Path Item Object and is capable of supporting runtime expressions which are evaluated in the context of a runtime HTTP request/response to identify the URL to be used for the callback request. The key must use valid runtime expression syntax. Expressions can be embedded into string values by surrounding the expression with {} curly braces.

PropertyValue
EnabledYes
SeverityWarning
MessageInvalid callback key found.
CodeOPENAPI3SYNTAX_V080
TypeValidation
Rule SystemSyntax
Broad CategoryCallbacks
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi syntax validation runtime expression expression callback

Suggested Fixes

  • Ensure that if you are using runtime expressions in your callback key string, the expressions follow valid syntax rules.
  • Ensure that all expressions start and end with a curly brace.

For More Information