object-schema-boundaries-defined
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
Schemas of type object must define the boundaries of the schema i.e. the maximum number of properties and the minimum number of properties.
| Property | Value |
|---|---|
| Enabled | No |
| Maximum Severity | Warning |
| Message | Schema boundaries are missing. |
| Code | OPENAPI3APIMATIC_L682 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Schemas |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi apimatic semantic linting minimum properties maximum properties schema |
Suggested Fixes
- Check the schema definition to confirm if the minimum and maximum number of properties are defined for the schema.
- If either the minimum or maximum number of properties is missing, add the missing property to the schema definition.
- Make sure that the minimum and maximum number of properties are specified with appropriate data types (integer) and have non-negative values.