experience-error-handling.html

Standardized, informative error responses across every operation.

51 rules experience: error-handling 48 inlined · 3 from the engine

Run this ruleset

Lint any matching artifact against this ruleset with the Spotlight CLI:

npm i -g @spotlight-rules/spotlight-cli
spotlight lint api.yaml \
  --ruleset https://apicommons.org/assets/rulesets/experience-error-handling.spotlight.yaml

Or load it into the browser validator, post it to the HTTP API, or wire it into a CI gate. 3 of these rules are the engine's built-ins (they come with spotlight:*); the other 48 are inlined in the file below.

Ruleset definition

Download YAML 

Loading…

Rules in this ruleset (51)

Arazzo Step Failure Actions Validation Arazzo engine
Arazzo Step Success Criteria Validation Arazzo engine
Operation Define 429 Response OpenAPI
Operation Define 500 Response OpenAPI
Operation Success Response OpenAPI engine
Operation Well Understood Status Codes OpenAPI
Response 400 Require Body OpenAPI
Response Code Must Be Valid OpenAPI
Response Define 401 OpenAPI
Response Define 404 OpenAPI
Response Define 429 OpenAPI
Response Define 500 OpenAPI
Response Delete 404 Use Schema Ref OpenAPI
Response Delete Codes Allowed OpenAPI
Response Delete Define 401 OpenAPI
Response Delete Define 500 OpenAPI
Response Delete Require 204 OpenAPI
Response Error Match Problem Schema OpenAPI
Response Error Require Description OpenAPI
Response Error Schema Problem Property Names OpenAPI
Response Error Standard Payload OpenAPI
Response Error Use Problem JSON OpenAPI
Response Error Use Problem Type OpenAPI
Response Error Use Problem Type 2 OpenAPI
Response Get Codes Allowed OpenAPI
Response Get Define 401 OpenAPI
Response Get Define 500 OpenAPI
Response Get Must Return 200 OpenAPI
Response Head Codes Allowed OpenAPI
Response Location Header Only On 201 OpenAPI
Response Options Codes Allowed OpenAPI
Response Patch Codes Allowed OpenAPI
Response Patch Define 200 OpenAPI
Response Patch Define 400 OpenAPI
Response Patch Define 404 OpenAPI
Response Post Codes Allowed OpenAPI
Response Post Define 400 OpenAPI
Response Post Define 401 OpenAPI
Response Post Define 500 OpenAPI
Response Post Require 201 Or 202 OpenAPI
Response Prefer 400 Over 422 OpenAPI
Response Put Codes Allowed OpenAPI
Response Put Define 400 OpenAPI
Response Put Define 401 OpenAPI
Response Put Define 500 OpenAPI
Response Status Path Problem Schema Fields OpenAPI
Response Status Path Return Problem Type OpenAPI
Response Throttled Require Retry After OpenAPI
Response Use Standard Status Codes OpenAPI
Response Use Standard Status Codes 2 OpenAPI
Schema Get Define 404 Response OpenAPI

← All experience rulesets