Requiring that all 4xx responses meets the policy standards.
Response 4xx
Rules
OpenAPI Response Get 400 Status Code Error
GET responses should have a 400 not found HTTP status code, communicating nothing was found to consumers
OpenAPI Response Get 400 Status Code Info
GET responses should have a 400 not found HTTP status code, communicating nothing was found to consumers
OpenAPI Response Get 401 Status Code Info
GET responses should have a 401 unauthorized HTTP status code, communicating that consumers do not have access
OpenAPI Response Get 401 Status Code Error
GET responses should have a 401 unauthorized HTTP status code, communicating that consumers do not have access
OpenAPI Response Get 403 Status Code Info
GET responses should have a 403 forbidden HTTP status code, communicating that consumers are not allowed to access
OpenAPI Response Get 403 Status Code Error
GET responses should have a 403 forbidden HTTP status code, communicating that consumers are not allowed to access
OpenAPI Response Get 404 Status Code Error
GET responses should have a 404 not found HTTP status code, communicating that nothing was found to consumers
OpenAPI Response Get 404 Status Code Info
GET responses should have a 404 not found HTTP status code, communicating that nothing was found to consumers
OpenAPI Response Get 429 Status Code Info
GET responses should have a 429 too many requests HTTP status code, communicating a consumer has made too may requests
OpenAPI Response Get 429 Status Code Error
GET responses should have a 429 too many requests HTTP status code, communicating a consumer has made too may requests
OpenAPI Response Get 400 Schema Ref Error
GET 400 bad request HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Get 400 Schema Ref Info
GET 400 bad request HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Get 401 Schema Ref Error
GET 401 unauthorized HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Get 401 Schema Ref Info
GET 401 unauthorized HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Get 403 Schema Ref Error
GET 403 forbidden HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Get 403 Schema Ref Info
GET 403 forbidden HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Get 404 Schema Ref Error
GET 404 not found HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Get 404 Schema Ref Info
GET 404 not found HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Get 429 Schema Ref Error
GET 429 too many requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Get 429 Schema Ref Info
GET 429 too many requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Post 400 Status Code Info
POST responses should have a 400 not found HTTP status code, communicating nothing was found to consumers
OpenAPI Response Post 400 Status Code Error
POST responses should have a 400 not found HTTP status code, communicating nothing was found to consumers
OpenAPI Response Post 401 Status Code Info
POST responses should have a 401 unauthorized HTTP status code, communicating that consumers do not have access
OpenAPI Response Post 401 Status Code Error
POST responses should have a 401 unauthorized HTTP status code, communicating that consumers do not have access
OpenAPI Response Post 403 Status Code Info
POST responses should have a 403 forbidden HTTP status code, communicating that consumers are not allowed to access
OpenAPI Response Post 403 Status Code Error
POST responses should have a 403 forbidden HTTP status code, communicating that consumers are not allowed to access
OpenAPI Response Post 404 Status Code Info
POST responses should have a 404 not found HTTP status code, communicating that nothing was found to consumers
OpenAPI Response Post 404 Status Code Error
POST responses should have a 404 not found HTTP status code, communicating that nothing was found to consumers
OpenAPI Response Post 429 Status Code Error
POST responses should have a 429 too many requests HTTP status code, communicating a consumer has made too may requests
OpenAPI Response Post 429 Status Code Info
POST responses should have a 429 too many requests HTTP status code, communicating a consumer has made too may requests
OpenAPI Response Post 400 Schema Ref Error
POST 400 bad request HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Post 400 Schema Ref Info
POST 400 bad request HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Post 401 Schema Ref Error
POST 401 unauthorized HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Post 401 Schema Ref Info
POST 401 unauthorized HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Post 403 Schema Ref Error
POST 403 forbidden HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Post 403 Schema Ref Info
POST 403 forbidden HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Post 404 Schema Ref Error
POST 404 not found HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Post 404 Schema Ref Info
POST 404 not found HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Post 429 Schema Ref Error
POST 429 too many requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Post 429 Schema Ref Info
POST 429 too many requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Put 400 Status Code Error
PUT responses should have a 400 not found HTTP status code, communicating nothing was found to consumers
OpenAPI Response Put 400 Status Code Info
PUT responses should have a 400 not found HTTP status code, communicating nothing was found to consumers
OpenAPI Response Put 401 Status Code Error
PUT responses should have a 401 unauthorized HTTP status code, communicating that consumers do not have access
OpenAPI Response Put 401 Status Code Info
PUT responses should have a 401 unauthorized HTTP status code, communicating that consumers do not have access
OpenAPI Response Put 403 Status Code Error
PUT responses should have a 403 forbidden HTTP status code, communicating that consumers are not allowed to access
OpenAPI Response Put 403 Status Code Info
PUT responses should have a 403 forbidden HTTP status code, communicating that consumers are not allowed to access
OpenAPI Response Put 404 Status Code Error
PUT responses should have a 404 not found HTTP status code, communicating that nothing was found to consumers
OpenAPI Response Put 404 Status Code Info
PUT responses should have a 404 not found HTTP status code, communicating that nothing was found to consumers
OpenAPI Response Put 429 Status Code Error
PUT responses should have a 429 too many requests HTTP status code, communicating a consumer has made too may requests
OpenAPI Response Put 429 Status Code Info
PUT responses should have a 429 too many requests HTTP status code, communicating a consumer has made too may requests
OpenAPI Response Put 400 Schema Ref Error
PUT 400 bad request HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Put 400 Schema Ref Info
PUT 400 bad request HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Put 401 Schema Ref Error
PUT 401 unauthorized HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Put 401 Schema Ref Info
PUT 401 unauthorized HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Put 403 Schema Ref Error
PUT 403 forbidden HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Put 403 Schema Ref Info
PUT 403 forbidden HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Put 404 Schema Ref Error
PUT 404 not found HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Put 404 Schema Ref Info
PUT 404 not found HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Put 429 Schema Ref Error
PUT 429 too many requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Put 429 Schema Ref Info
PUT 429 too many requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Delete 400 Status Code Error
DELETE responses should have a 400 not found HTTP status code, communicating nothing was found to consumers
OpenAPI Response Delete 400 Status Code Info
DELETE responses should have a 400 not found HTTP status code, communicating nothing was found to consumers
OpenAPI Response Delete 401 Status Code Error
DELETE responses should have a 401 unauthorized HTTP status code, communicating that consumers do not have access
OpenAPI Response Delete 401 Status Code Info
DELETE responses should have a 401 unauthorized HTTP status code, communicating that consumers do not have access
OpenAPI Response Delete 403 Status Code Error
DELETE responses should have a 403 forbidden HTTP status code, communicating that consumers are not allowed to access
OpenAPI Response Delete 403 Status Code Info
DELETE responses should have a 403 forbidden HTTP status code, communicating that consumers are not allowed to access
OpenAPI Response Delete 404 Status Code Error
DELETE responses should have a 404 not found HTTP status code, communicating that nothing was found to consumers
OpenAPI Response Delete 404 Status Code Info
DELETE responses should have a 404 not found HTTP status code, communicating that nothing was found to consumers
OpenAPI Response Delete 429 Status Code Error
DELETE responses should have a 429 too many requests HTTP status code, communicating a consumer has made too may requests
OpenAPI Response Delete 429 Status Code Info
DELETE responses should have a 429 too many requests HTTP status code, communicating a consumer has made too may requests
OpenAPI Response Delete 400 Schema Ref Error
DELETE 400 bad request HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Delete 400 Schema Ref Info
DELETE 400 bad request HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Delete 401 Schema Ref Error
DELETE 401 unauthorized HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Delete 401 Schema Ref Info
DELETE 401 unauthorized HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Delete 403 Schema Ref Error
DELETE 403 forbidden HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Delete 403 Schema Ref Info
DELETE 403 forbidden HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Delete 404 Schema Ref Error
DELETE 404 not found HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Delete 404 Schema Ref Info
DELETE 404 not found HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Delete 429 Schema Ref Error
DELETE 429 too many requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Delete 429 Schema Ref Info
DELETE 429 too many requests HTTP status codes have a schema references to standardize the response payload returned for the error response
Strategies
API Errors Are Standardized and Informative
All API error responses must follow standardized formats like RFC 7807 Problem Details, providing consistent error codes, human-readable messages, and correlation IDs that enable consumers to progr...
API Responses Must Be Meaningful and Consistent
All API responses should follow Internet, industry, and enterprise standards, providing a meaningful and consistent communication and structure, always providing what was intended for API consumers...
Lifecycle
design_services Design Design
Design is where the human experience of an API is won or lost. I work design-first, shaping the paths, schema, errors, and naming in the contract before development begins, so that consistency is b...
