Skip to main content

valid-server-url-format

Overview​

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

Value must be in the format of a URL. A URL can either be absolute or relative and can contain variables wrapped in {}.

PropertyValue
EnabledYes
Maximum SeverityError
MessageInvalid server URL found.
CodeOPENAPI3SYNTAX_V001
TypeValidation
Rule SystemSyntax
Broad CategoryServers
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi syntax validation url server

Suggested Fixes​

  • Ensure that the URL does not contain any forbidden characters.
  • If you have declared any server variables, ensure that the variable segment in the URL starts and ends properly with a curly brace {}.

For More Information​