Linting Rules - OpenAPI V3 - Schema Properties Names Length

Number of APIs: 1

This is a Spectral governance rule to make sure that all schema property names are not too long 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-names-length": {
    "description": "Ensuring that property names are no more than 25 characters.",
    "message": "Schema property names should be less than 25 characters .",
    "severity": "error",
    "given": "$..properties.*",
    "then": {
      "field": "@key",
      "function": "length",
      "functionOptions": {
        "max": 25
      }
    }
  }
}

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 Names Length POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/openapi-v3-schema-properties-names-length/