Requiring that all schema names meets the policy standards.
Schema Names
Rules
OpenAPI Schema Names Pascal Case Error
Schema names are pascal case, keeping the naming of them consistent across APIs, standardizing how consumers can use in their applications
OpenAPI Schema Names Pascal Case Info
Schema names are pascal case, keeping the naming of them consistent across APIs, standardizing how consumers can use in their applications
OpenAPI Schema Names Length Error
Schema should have a length limit applied keeping the names of schema 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...
