Linting Rules - OpenAPI V3 - Operations Description Length

Number of APIs: 1

This is a Spectral governance rule to enforce the length of API operation descriptions within 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-operations-description-length": {
    "description": "Ensures that the description for operations are not too long.",
    "message": "Your operation descriptions should not be more than 250 characters.",
    "given": "$.paths.*[get,post,patch,put,delete]",
    "recommended": true,
    "then": [
      {
        "field": "description",
        "function": "length",
        "functionOptions": {
          "max": 250
        }
      }
    ],
    "type": "style"
  }
}

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