Requiring that all operational parameters names meets the policy standards.
Parameter Names
Rules
OpenAPI Components Parameters Name Error
Giving 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
Giving 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
Giving 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 Info
Giving parameters with consistent naming helps make it easier for API consumers to understand how they are able to configure their API requests
Strategies
Operations Must Be Useful and Consistent
Every API operation should do one thing and do it well. That is the Unix philosophy applied to APIs and it still holds up. When your operations follow common standards with consistent naming, clear...
API Parameters Are Well-Defined and Consistent
Parameters are part of the surface area that consumers interact with on every single call, and when they are inconsistent--different casing, unclear names, missing descriptions--it creates friction...