Linting Rules - OpenAPI V3 - Schema Properties Descriptions Words

Number of APIs: 1

This is a Spectral governance rule to make sure that some words aren't used in schema property descriptions within OpenAPI definitions. 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-schema-properties-descriptions-words": {
    "description": "Some words should not exist within the property description.",
    "message": "Schema property descriptions should not contain the words word, word, and word.",
    "severity": "warn",
    "formats": [
      "oas3"
    ],
    "given": "$..properties.*",
    "then": {
      "field": "description",
      "function": "pattern",
      "functionOptions": {
        "notMatch": "\\b(word|word|word)\\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 - Schema Properties Descriptions Words POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/openapi-v3-schema-properties-descriptions-words/