Linting Rules - OpenAPI V3 - Use of Response Schema oneOf

Number of APIs: 1

This is a Spectral governance rule to enforce that check to see if oneOf property is being used as part of the schema for any OpenAPI. 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-use-of-response-schema-oneof": {
    "description": "Checks to see if oneOf is being used as part of each schema.",
    "message": "You should avoid using oneOf as part of your schema.",
    "given": "$.paths.*.*[responses]..content..schema",
    "severity": "warn",
    "formats": [
      "oas3"
    ],
    "then": {
      "field": "oneOf",
      "function": "falsy"
    }
  }
}

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 - Use of Response Schema oneOf POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/openapi-v3-use-of-response-schema-oneof/