Skip to main content

Recommended HTTP Codes

ItemDescription
Full Fuzzer NameRecommendedHttpCodesLinterFuzzer
Log KeyRHCL
DescriptionThis fuzzer will check that each path element and http methods defines recommended HTTP response codes. See below table for details.
Enabled by default?No. You need to use the cats lint ... sub-command.
Target contract elementsOpenAPI contract metadata and structures relevant to this rule.
Expected resultsuccess when no violation is found; error when the rule is violated.
Fuzzing logicInspects the OpenAPI contract without sending HTTP requests and reports violations of this rule.
Conditions when this fuzzer will be skippedNone; the linter runs once for the supplied contract.
HTTP methods that will be skippedN/A — no HTTP requests are sent.
ReportingReports error if the http method from path does not have the recommended response codes, or success otherwise.
HTTP MethodRecommended Response Codes List
POST400, 500, 2XX
PUT400, 404, 500, 2XX
GET400, 404, 500, 200, 202
HEAD404, 200, 202
DELETE400, 404, 500, 2XX
PATCH400, 404, 500, 2XX
TRACE400, 500, 200