Linting Rules - Swagger V2 - Info X API Id

Number of APIs: 1

This is a Spectral governance rule to enforce that the Swagger info has an API ID extension. 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-info-x-api-id": {
    "description": "Ensures that all Swaggers have a information object API ID extension.",
    "message": "The info object should have an API ID extension.",
    "given": "$.info",
    "severity": "error",
    "recommended": true,
    "type": "style",
    "then": {
      "field": "x-api-id",
      "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 - Info X API Id POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/swagger-v2-info-x-api-id/