Requiring that all operational parameters names meets the policy standards.
Parameter Names
Rules
OpenAPI Components Parameters Name Error
Providing a simple, intuitive, and consistent names for your parameters helps make it easier for API consumers to understand how they are able to configure their API requests
OpenAPI Components Parameters Name Info
Providing a simple, intuitive, and consistent names for your parameters helps make it easier for API consumers to understand how they are able to configure their API requests
OpenAPI Components Parameters Name Length Error
Providing short and concise names for your parameters helps make it easier for API consumers to understand how they are able to configure their API requests
OpenAPI Components Parameters Casing Camel Warn
Component parameter names should be written in camelCase so that consumers encounter consistent, predictable naming across every operation in the API.
OpenAPI Components Parameters Casing Camel Info
Providing parameters with consistent naming helps make it easier for API consumers to understand how they are able to configure their API requests
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...
