Requiring that all schema property descriptions meets the policy standards.
Schema Property Descriptions
Rules
OpenAPI Schema Properties Descriptions Error
Schema properties should have descriptions that provide a narrative of the property contains, and how it can be used
OpenAPI Schema Properties Descriptions Info
Schema properties should have descriptions that provide a narrative of the property contains, and how it can be used
OpenAPI Schema Properties Descriptions Length Error
Schema property descriptions should have a length limit applied, applying constraints to writing descriptions, and keeping consistent across APIs
Strategies
Data Should Be Well-Defined and Validated
The schema for data that is sent and received via API should always be well-defined, possess a well-known shape, and always be validated, ensuring that digital resources and capabilities are what t...
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...
