Linting Rules - OpenAPI V3 - Responses Schema Object
Number of APIs: 1
This is a Spectral governance rule to make sure that all responses have schema defined in an 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-responses-schema-object": {
"description": "Ensuring all responses have a schema defined.",
"message": "All your responses need to have a schema defined.",
"severity": "error",
"given": "$.paths.*.*[responses]..content..schema",
"then": {
"function": "is-object-schema"
}
}
}
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.
- OpenAPI V3 - Responses Schema Object POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/openapi-v3-responses-schema-object/