no-large-payload
Overview
This rule belongs to the api-blueprint-validation ruleset and states that:
The input API Blueprint/Elements file provided must not be very large. Keep the size optimal to avoid any issues.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Blocking |
| Message | Input file is too large. |
| Code | APIBLUEPRINT_V004 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Basic Structure |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | api blueprint api elements api semantic validation payload file size |
Suggested Fixes
- Avoid uploading very large files.
- Remove any extra/irrelevant data from the file to reduce its size.