Skip to main content

valid-link-parameter-expression

Overview​

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

Link parameter value is a string used for determining the parameter value that needs to be sent as part of the callback request. This value is capable of supporting runtime expressions which are evaluated in the context of a runtime HTTP request/response. The value must use valid runtime expression syntax. Expressions can be embedded into string values by surrounding the expression with {} curly braces.

PropertyValue
EnabledYes
Maximum SeverityWarning
MessageInvalid link parameter value found.
CodeOPENAPI3SYNTAX_V101
TypeValidation
Rule SystemSyntax
Broad CategoryLinks
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi syntax validation runtime expression expression parameter link

Suggested Fixes​

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

For More Information​