Skip to main content



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

An example entry from the multiple examples list must have either an example value set or an alternate external URL from which the example value can be fetched.

Maximum SeverityWarning
MessageExample value and external URL for value are both found to be null/empty.
Rule SystemSemantic
Broad CategoryExamples
Products ImpactedDeveloper Experience Portal
Tagsportal generation portal docs linting apimatic value sample value example external url external value

Suggested Fixes

  • If an external URL is not available, make sure that the example value is not null or empty.
  • If the example value cannot be embedded within your API description file, make sure you set an external publicly-accessible URL that points to that example value.
  • Remove the example entry from the multiple examples list.

For More Information