Linting Rules - OpenAPI V3 - Limit Number of Paths

Number of APIs: 1

This is a Spectral governance rule to make sure that there aren't too many paths in an OpenAPI. 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-limit-number-of-paths": {
    "description": "Ensures that there are not too many paths.",
    "message": "There should be no more than 10 paths.",
    "severity": "warn",
    "given": "$.paths",
    "then": {
      "function": "count-resource-types",
      "functionOptions": {
        "max": 10
      }
    }
  }
}

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 - Limit Number of Paths POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/openapi-v3-limit-number-of-paths/