Linting Rules - OpenAPI V3 - Operations Description

Number of APIs: 1

This is a Spectral governance rule to make sure that some words are never used in the description of operations within an OpenAPI. 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-operations-description": {
    "description": "Ensures that each of the operations have a description.",
    "message": "Your operations all need descriptions.",
    "severity": "error",
    "given": "$.paths.*[get,post,patch,put,delete]",
    "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. OpenAPI V3 - Operations Description POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/openapi-v3-operations-description/