Linting Rules - OpenAPI V3 - Version Second Segment

Number of APIs: 1

This is a Spectral governance rule to make sure that the second segment of the path a version. 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-version-segment-second": {
    "description": "Ensuring the second path segment is a version like v1.",
    "message": "The second path segment should be the version.",
    "given": "$.paths",
    "then": {
      "field": "@key",
      "function": "pattern",
      "functionOptions": {
        "match": "^/[^/]+/v\\d+/.+$"
      }
    }
  }
}

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 - Version Second Segment POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/openapi-v3-version-segment-second/