array-schema-boundaries-defined
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
In OpenAPI specifications, array boundaries should be defined for schemas that include array data types.
| Property | Value |
|---|---|
| Enabled | No |
| Maximum Severity | Warning |
| Message | Array boundaries are not defined. |
| Code | OPENAPI3APIMATIC_L689 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Schemas |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi apimatic semantic linting array boundaries minItems maxItems schema |
Suggested Fixes
- Check if the OpenAPI schema with an array data type has undefined boundaries.
- If any schema with an array data type has undefined boundaries, define the boundaries for the schema. The boundaries include the minimum and maximum number of items that can be included in the array (i.e. minItems, maxItems).