Requiring that all operational parameters schema meets the policy standards.
Parameter Schema
Rules
OpenAPI Components Parameters Schema Error
Parameters must always possess a schema to help define the format and shape of the parameter, setting expections with consumers about what should be passed in
OpenAPI Components Parameters Schema Info
Parameters must always possess a schema to help define the format and shape of the parameter, setting expections with consumers about what should be passed in
OpenAPI Components Parameters Schema Ref Error
Parameters must always use a schema reference that utilizes reusable schema that are defined as part of a centralized schema components library
OpenAPI Components Parameters Schema Ref Info
Parameters must always use a schema reference that utilizes reusable schema that are defined as part of a centralized schema components library
Strategies
API Parameters Are Well-Defined and Consistent
All API parameters must have clear names, descriptions, types, and constraints following consistent casing and naming conventions, with reusable parameters centralized in OpenAPI components to redu...
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...
