Linting Rules - OpenAPI V3 Have Request Body Examples

Number of APIs: 1

This is a Spectral governance rule to enforce that all OpenAPI request bodies have an example present, showing what is expected when a request body is submitted as part of an API request. 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-have-request-body-examples": {
    "severity": "error",
    "description": "Ensures that a example is always present for each request body.",
    "message": "All request bodies should have an example present.",
    "given": "$.paths.*.*.requestBody..[?(@.items)][?(@.type == 'object')]",
    "formats": [
      "oas3"
    ],
    "then": [
      {
        "field": "example",
        "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. OpenAPI V3 Have Request Body Examples POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/openapi-v3-have-request-body-examples/