Linting Rules - Swagger V2 Info Description Word Check

Number of APIs: 1

This is a Spectral governance rule to enforce that an Swagger information object description does not contain certain words. 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-info-description-word-check": {
    "description": "Ensures that all APIs descriptions do not contain certain words.",
    "message": "The info object description cannot contain the words REST, public, developer.",
    "given": "$.info.description",
    "severity": "error",
    "recommended": true,
    "type": "style",
    "formats": [
      "oas2"
    ],
    "then": {
      "function": "pattern",
      "functionOptions": {
        "notMatch": "\\b(REST|Public|Developer)\\b"
      }
    }
  }
}

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 Info Description Word Check POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/swagger-v2-info-description-word-check/