Linting Rules - OpenAPI V3 - Info Summary Word Check

Number of APIs: 1

This is a Spectral governance rule to enforce that OpenAPI info object summary 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.

{
  "openapi-v3-info-summary-word-check": {
    "description": "Ensures that all OpenAPIs information object summary do not contain some words.",
    "message": "The info object summary should not contain the words REST, Public, or Developer.",
    "given": "$.info.summary",
    "severity": "error",
    "recommended": true,
    "type": "style",
    "formats": [
      "oas3"
    ],
    "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. OpenAPI V3 - Info Summary Word Check POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/openapi-v3-info-summary-word-check/