Linting Rules - OpenAPI V3 Responses Examples Components

Number of APIs: 1

This is a Spectral governance rule to enforce that the OpenAPI response examples are all centralized as a component. 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-responses-examples-components": {
    "description": "Check response examples to ensure that they only have references to components.",
    "message": "Response examples should only reference components.",
    "severity": "error",
    "resolved": false,
    "given": [
      "$..responses.*.content..*.examples.$ref"
    ],
    "then": {
      "function": "pattern",
      "functionOptions": {
        "match": "#/components/"
      }
    }
  }
}

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 Responses Examples Components POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/openapi-v3-responses-examples-components/