Linting Rules - Swagger V2 - Schema Properties Descriptions Length

Number of APIs: 1

This is a Spectral governance rule to make sure that schema property descriptions are too long within Swagger definitions. 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.

{
  "swagger-v2-schema-properties-descriptions-length": {
    "description": "Ensure that schema descriptions aren't too long.",
    "message": "The schema description length needs to be less than 250 characters.",
    "severity": "warn",
    "formats": [
      "oas2"
    ],
    "given": "$.definitions.properties.*",
    "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. Swagger V2 - Schema Properties Descriptions Length POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/swagger-v2-schema-properties-descriptions-length/