Requiring that all operational request body schema meets the policy standards.
Request Bodies Schema
Rules
OpenAPI Request Body Have Schema Error
Request body media types must define a schema so that the structure of the expected payload is documented and can be validated by consumers and tooling.
OpenAPI Request Body Have Schema Info
Request body media types must define a schema so that the structure of the expected payload is documented and can be validated by consumers and tooling.
OpenAPI Request Body Have Schema Ref Error
Request body schemas should be defined as $ref references to a centralized schema library so that data models are reused and maintained consistently.
OpenAPI Request Body Have Schema Ref Info
Request body schemas should be defined as $ref references to a centralized schema library so that data models are reused and maintained consistently.
OpenAPI Request Body On Post Error
POST operations should define a request body, since creating a resource almost always requires the consumer to submit a representation of that new resource.
OpenAPI Request Body On Post Info
POST operations should define a request body, since creating a resource almost always requires the consumer to submit a representation of that new resource.
OpenAPI Request Body On Put Error Info
PUT operations should define a requestBody because they typically replace a resource and require the client to send the representation being stored.
OpenAPI Request Body On Put Info
PUT operations should define a requestBody because they typically replace a resource and require the client to send the representation being stored.
OpenAPI Response Put 204 No Body Error
A PUT operation that returns a 204 No Content response must not define response content, as a 204 status code indicates there is no body to return.
OpenAPI Response Delete 204 No Body Error
A DELETE operation that returns a 204 No Content response must not define response content, as a 204 status code indicates there is no body to return.
Strategies
Operations Must Be Useful and Consistent
All individual API operations must be useful and follow consistent Internet, industry, and enterprise standards, providing a simple and relevant HTTP API operation that does one thing and does it w...
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...
