Skip to main content

valid-example-external-value-url

Overview

This rule belongs to the apimatic-docs-linting ruleset and states that:

The external URL provided for example, from which the example value is retrieved, must be a valid publicly-accessible URL.

PropertyValue
EnabledYes
Maximum SeverityWarning
MessageExternal URL provided for example is invalid.
CodeAPIMATICDOCS_L109
TypeLinting
Rule SystemSemantic
Broad CategoryExamples
Products ImpactedDeveloper Experience Portal
Tagsportal generation portal docs linting apimatic external value url example value

Suggested Fixes

  • Make sure that the URL is an absolute path.
  • Make sure that the URL is publicly accessible. URLs containing localhost are not valid URLs.
  • Make sure that the URL does not contain any forbidden characters.

For More Information