Requiring that all operational request body examples meets the policy standards.
Request Bodies Examples
Rules
OpenAPI Request Body Have Examples Error
Request body media types should provide examples so that consumers can understand the expected payload structure and values when calling the API.
OpenAPI Request Body Have Examples Info
Request body media types should provide examples so that consumers can understand the expected payload structure and values when calling the API.
OpenAPI Request Body Have Examples Ref Error
Request body examples should be defined as $ref references to a centralized examples library so that they can be reused and maintained consistently.
OpenAPI Request Body Have Examples Ref Info
Request body examples should be defined as $ref references to a centralized examples library so that they can be reused and maintained consistently.
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...
menu_book Documentation Beta
Documentation is the API for humans. I generate reference docs from the definition and surround them with the guides, examples, and getting-started material that turn a spec into understanding. Doc...
