Requiring that all schema property names meets the policy standards.
Schema Property Names
Rules
OpenAPI Schema Properties Names Camel Case Error
Schema property names are camel case, providing consistent casing across all the schema properties used by APIs
OpenAPI Schema Properties Names Camel Case Info
Schema property names are camel case, providing consistent casing across all the schema properties used by APIs
OpenAPI Schema Properties Names Length Error
Schema property names have a length restriction applied, keeping names consistent, and avoiding being too long
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...