Linting Rules - Swagger V2 Info Description

Number of APIs: 1

This is a Spectral governance rule to enforce that an Swagger has a description included as part of the information object, making sure there is as much detail about what an API does available for consumers. 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": {
    "description": "Ensures that all Swaggers have a information description.",
    "message": "The info object should have a description.",
    "given": "$.info",
    "severity": "error",
    "recommended": true,
    "type": "style",
    "formats": [
      "oas2"
    ],
    "then": {
      "field": "description",
      "function": "truthy"
    }
  }
}

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.

Swagger V2 Info Description POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/swagger-v2-info-description/