Requiring that all 5xx responses meets the policy standards.
Response 5xx
Rules
OpenAPI Response Get 500 Status Code Error
GET responses should have a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers
OpenAPI Response Get 500 Status Code Info
GET responses should have a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers
OpenAPI Response Get 500 Schema Ref Error
GET 500 internal server error requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Get 500 Schema Ref Info
GET 500 internal server error requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Post 500 Status Code Error
POST responses should have a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers
OpenAPI Response Post 500 Status Code Info
POST responses should have a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers
OpenAPI Response Post 500 Schema Ref Error
POST 500 internal server error requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Post 500 Schema Ref Info
POST 500 internal server error requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Put 500 Status Code Error
PUT responses should have a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers
OpenAPI Response Put 500 Status Code Info
PUT responses should have a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers
OpenAPI Response Put 500 Schema Ref Error
PUT 500 internal server error requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Put 500 Schema Ref Info
PUT 500 internal server error requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Delete 500 Status Code Error
DELETE responses should have a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers
OpenAPI Response Delete 500 Status Code Info
DELETE responses should have a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers
OpenAPI Response Delete 500 Schema Ref Error
DELETE 500 internal server error requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Delete 500 Schema Ref Info
DELETE 500 internal server error 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...
