Linting Rules - OpenAPI V3 - Schema Properties Define Array Boundaries

Number of APIs: 1

This is a Spectral governance rule to enforce that arrays in an OpenAPI always have minimum and maximum boundaries define, preventing these properties from being overloaded. Here is a JSON version of the rule that can be applied using this API-driven collection API, or at CLI or CI/CD pipeline.

{
  "openapi-v3-schema-properties-define-array-boundaries": {
    "description": "Requires that arrays have their minimum and maximum boundaries defined.",
    "message": "Arrays must have minItems and maxItems defined.",
    "formats": [
      "oas3"
    ],
    "severity": "warn",
    "recommended": true,
    "given": [
      "$..properties.[?(@.type==\"array\")]"
    ],
    "then": [
      {
        "field": "maxItems",
        "function": "defined"
      },
      {
        "field": "minItems",
        "function": "defined"
      }
    ]
  }
}

This request can be run as part of this collection, or dragged and dropped to another collection of governance requests organized by folder, demonstrating how API governance linting works, but also providing a rule that can be used as part of your wider API governance strategy.

1. OpenAPI V3 - Schema Properties Define Array Boundaries POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/openapi-v3-schema-properties-define-array-boundaries/