Linting Rules - OpenAPI V3 - Response PUT 204 Problem JSON Media Type
Number of APIs: 1
This is a Spectral governance rule to make sure that PUT methods all have a 500 status code response with application/json media type 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-response-put-204-problem-json-media-type": {
"description": "Ensuring PUT operations have an application/problem+json media type for 500 responses.",
"message": "A PUT operation should have an application/problem+json media type for 500 response.",
"severity": "error",
"given": "$paths.put.responses.500.content",
"then": {
"field": "application/problem+json",
"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.