Requiring that all 2xx responses meets the policy standards.
Response 2xx
Rules
OpenAPI Response Get 200 Status Code Error
GET responses should have a 200 success HTTP status codes, communicating a successful response to consumers
OpenAPI Response Get 200 Status Code Info
GET responses should have a 200 success HTTP status codes, communicating a successful response to consumers
OpenAPI Response Get 200 Description Error
GET 200 success HTTP status codes should have a description, describing what an API consumer can expect as a result
OpenAPI Response Get 200 Description Info
GET 200 success HTTP status codes should have a description, describing what an API consumer can expect as a result
OpenAPI Response Get 200 Content Error
GET 200 success HTTP status codes should have content property that provides the ability to describe the response content
OpenAPI Response Get 200 Content Info
GET 200 success HTTP status codes should have content property that provides the ability to describe the response content
OpenAPI Response Get 200 Media Type Error
GET 200 success HTTP status codes have a application/json media type, standardizing the response payload returned for a successful response
OpenAPI Response Get 200 Media Type Info
GET 200 success HTTP status codes have a application/json media type, standardizing the response payload returned for a successful response
OpenAPI Response Get 200 Media Type Schema Error
GET 200 success HTTP status codes have a schema to standardize the response payload returned for a successful response
OpenAPI Response Get 200 Media Type Schema Info
GET 200 success HTTP status codes have a schema to standardize the response payload returned for a successful response
OpenAPI Response Get 200 Media Type Schema Ref Error
GET 200 success HTTP status codes have a schema references to standardize the response payload returned for a successful response
OpenAPI Response Get 200 Media Type Schema Ref Info
GET 200 success HTTP status codes have a schema references to standardize the response payload returned for a successful response
OpenAPI Response Get 200 Media Type Examples Error
GET 200 success HTTP status codes have examples to show one or many examples of responses for different types of API requests
OpenAPI Response Get 200 Media Type Examples Info
GET 200 success HTTP status codes have examples to show one or many examples of responses for different types of API requests
OpenAPI Response Get 200 Media Type Examples Ref Error
GET 200 success HTTP status codes have example references to show one or many examples of responses for different types of API requests
OpenAPI Response Get 200 Media Type Examples Ref Info
GET 200 success HTTP status codes have example references to show one or many examples of responses for different types of API requests
OpenAPI Response Post 201 Media Type Schema Error
POST 201 success HTTP status codes have a schema to standardize the response payload returned for a successful response
OpenAPI Response Post 201 Media Type Schema Info
POST 201 success HTTP status codes have a schema to standardize the response payload returned for a successful response
OpenAPI Response Post 201 Schema Ref Error
POST 201 success HTTP status codes have a schema references to standardize the response payload returned for a successful response
OpenAPI Response Post 201 Schema Ref Info
POST 201 success HTTP status codes have a schema references to standardize the response payload returned for a successful response
OpenAPI Response Post 201 Status Code Error
POST responses should have a 201 success HTTP status codes, communicating a success created response to consumers
OpenAPI Response Post 201 Status Code Info
POST responses should have a 201 success HTTP status codes, communicating a success created response to consumers
OpenAPI Response Post 201 Description Error
POST 201 success HTTP status codes should have a description, describing what an API consumer can expect as a result
OpenAPI Response Post 201 Description Info
POST 201 success HTTP status codes should have a description, describing what an API consumer can expect as a result
OpenAPI Response Post 201 Content Error
POST 201 success HTTP status codes should have content property that provides the ability to describe the response content
OpenAPI Response Post 201 Content Info
POST 201 success HTTP status codes should have content property that provides the ability to describe the response content
OpenAPI Response Post 201 Media Type Error
POST 201 success HTTP status codes have a application/json media type, standardizing the response payload returned for a successful response
OpenAPI Response Post 201 Media Type Info
POST 201 success HTTP status codes have a application/json media type, standardizing the response payload returned for a successful response
OpenAPI Response Post 201 Media Type Examples Error
POST 201 success HTTP status codes have examples to show one or many examples of responses for different types of API requests
OpenAPI Response Post 201 Media Type Examples Info
POST 201 success HTTP status codes have examples to show one or many examples of responses for different types of API requests
OpenAPI Response Post 201 Examples Ref Error
POST 201 success HTTP status codes have example references to show one or many examples of responses for different types of API requests
OpenAPI Response Post 201 Examples Ref Info
POST 201 success HTTP status codes have example references to show one or many examples of responses for different types of API requests
OpenAPI Response Put 204 Status Code Error
PUT responses should have a 204 success HTTP status codes, communicating a success created response to consumers
OpenAPI Response Put 204 Status Code Info
PUT responses should have a 204 success HTTP status codes, communicating a success created response to consumers
OpenAPI Response Delete 204 Status Code Error
DELETE responses should have a 204 success HTTP status codes, communicating a success created response to consumers
OpenAPI Response Delete 204 Status Code Info
DELETE responses should have a 204 success HTTP status codes, communicating a success created response to consumers
Strategies
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...
