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.
Property | Value |
---|---|
Enabled | Yes |
Maximum Severity | Warning |
Message | Sample value provided for an error with no model type. |
Code | APIMATICDOCS_L103 |
Type | Linting |
Rule System | Semantic |
Broad Category | Examples |
Products Impacted | Developer Experience Portal |
Tags | portal 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.