Skip to main content

no-example-for-error-with-no-model

Overview

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

An example must not be set for a error response that has no error model linked to it.

PropertyValue
EnabledYes
Maximum SeverityWarning
MessageSample value provided for an error with no model type.
CodeAPIMATICDOCS_L103
TypeLinting
Rule SystemSemantic
Broad CategoryExamples
Products ImpactedDeveloper Experience Portal
Tagsportal generation portal docs linting apimatic sample value example error response endpoint

Suggested Fixes

  • Define a corresponding exception model for the error and then try again.
  • Remove the example set for error with no model type set.

For More Information