Linting Rules - Swagger V2 - Parameters Description

Number of APIs: 1

This is a Spectral governance rule to make sure that all parameters have a description in an Swagger. 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-parameters-description": {
    "description": "Ensures that that all parameters have a descriptions.",
    "message": "Your parameters all need descriptions.",
    "given": "$.paths.*.*.parameters[?(@.in=='query')]",
    "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.

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