predefined-default-success-response
Overview
This rule belongs to the apimatic-preliminary-validation ruleset and states that:
An endpoint must consist of a default success response definition.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | The default success response of the endpoint is undefined. |
| Code | APIMATICPRE_V306 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Endpoint Responses |
| Products Impacted | Code Generation, Developer Experience Portal, API Transformer |
| Tags | preliminary checks validation apimatic response endpoint |
Suggested Fixes
- Define the default response in the endpoint and set the type as "Void" if no response body is expected. If a response body is expected, set an appropriate type accordingly.
- Valid success response status code range is 200-208.