Requiring that all operational parameters in property meets the policy standards.
Parameter In Query or Path
Rules
OpenAPI Components Parameters In Error
Giving an in property for parameters gets explicit about whether a parameter is in the path, query, or a header, making it clear to consumers where they can configure their request
OpenAPI Components Parameters In Info
Giving an in property for parameters gets explicit about whether a parameter is in the path, query, or a header, making it clear to consumers where they can configure their request
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...