no-example-for-error-with-no-model
Overview
This rule belongs to the apimatic-post-processing-validation 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 was provided for an error with no model type, therefore, it has been removed. |
| Code | APIMATICPOSTPROCESS_V503 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Examples |
| Products Impacted | Code Generation, Developer Experience Portal, API Transformer |
| Tags | apimatic postprocessing validation sample value error response endpoint |
Suggested Fixes
- Define a corresponding exception model for the error and then try again.
- Avoid setting an example for errors that have no model type set.