Linting Rules - OpenAPI V3 - Parameters Description Length

Number of APIs: 1

This is a Spectral governance rule to make sure that all parameters description are not too long. 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-parameters-description-length": {
    "description": "Ensures that each of parameter description isn't too long.",
    "message": "Your parameter descriptions can't be more than 500 characters.",
    "given": "$.paths.*.*.parameters[?(@.in=='query')].description",
    "then": {
      "field": "summary",
      "function": "length",
      "functionOptions": {
        "max": 500
      }
    }
  }
}

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