Requiring that all operational request bodies meets the policy standards.
Request Bodies
Rules
OpenAPI No Request Body On Delete Error
DELETE operations must not define a request body, since the resource to remove is identified by the path and a payload can be silently ignored by servers.
OpenAPI No Request Body On Delete Info
DELETE operations should not define a request body, since the resource to remove is identified by the path and a payload can be silently ignored by servers.
OpenAPI No Request Body On Get Error
GET operations must not define a request body, keeping reads safe and cacheable and avoiding payloads that many clients and servers will ignore.
OpenAPI No Request Body On Get Info
GET operations should not define a request body, keeping reads safe and cacheable and avoiding payloads that many clients and servers will ignore.
OpenAPI Request Bodies Description Error
It is helpful to provide a description for request bodies, providing a simple explanation of what can be configured as part of the request payload
OpenAPI Request Bodies Description Info
It is helpful to provide a description for request bodies, providing a simple explanation of what can be configured as part of the request payload
OpenAPI Request Bodies Required Property Error
It is important to be explicit about whether or not the request body for an API operation is required or not
OpenAPI Request Bodies Required Property Info
It is important to be explicit about whether or not the request body for an API operation is required or not
OpenAPI Request Body Content On Post Error
A POST request body must define its content so that consumers know which media types and schemas are expected when creating a resource.
OpenAPI Request Body Content On Post Info
A POST request body should define its content so that consumers know which media types and schemas are expected when creating a resource.
OpenAPI Request Body Content On Put Error
A PUT request body must define its content so that consumers know which media types and schemas are expected when replacing a resource.
OpenAPI Request Body Content On Put Info
A PUT request body should define its content so that consumers know which media types and schemas are expected when replacing a resource.
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...
