Linting Rules - OpenAPI V3 - Info Description Max Length

Number of APIs: 1

This is a Spectral governance rule to enforce that an OpenAPI information object description meet a specific length requirement, making sure that descriptions aren't too long, and provide the precise right amount of information for consumers.. 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-info-description-max-length": {
    "description": "Ensures that all APIs descriptions are under a specific length.",
    "message": "The info object description should be less than 250 characters.",
    "given": "$.info",
    "severity": "error",
    "recommended": true,
    "type": "style",
    "formats": [
      "oas3"
    ],
    "then": {
      "field": "description",
      "function": "length",
      "functionOptions": {
        "max": 250
      }
    }
  }
}

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 - Info Description Max Length POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/openapi-v3-info-description-max-length/