Skip to main content

valid-endpoint-relative-route

Overview

This rule belongs to the apimatic-preliminary-validation ruleset and states that:

Endpoint route must be a relative path to the base server URL and begin with a leading forward slash "/". It must also consist of valid path segments.

PropertyValue
EnabledYes
Maximum SeverityError
MessageEndpoint route is invalid.
CodeAPIMATICPRE_V102
TypeValidation
Rule SystemSemantic
Broad CategoryEndpoints
Products ImpactedCode Generation, Developer Experience Portal, API Transformer
Tagspreliminary checks validation apimatic route path endpoint

Suggested Fixes

  • Make sure your endpoint route/path begins with a forward slash.
  • Make sure that the route does not contain any forbidden characters.
  • Use curly braces "{", "}" for any template/path parameters.

For More Information