Requiring that all operational parameters descriptions meets the policy standards.
Parameter Descriptions
Rules
OpenAPI Components Parameters Description Error
You need a parameters description provides more depth to what a parameter does and will be displayed via documentation, and other tooling used across the API lifecycle
OpenAPI Components Parameters Description Info
You need a parameters description provides more depth to what a parameter does and will be displayed via documentation, and other tooling used across the API lifecycle
OpenAPI Components Parameters Description Length Error
Limiting the length of parameters description forces us to be more concise in how we describe each parameter, while keeping our documentation and other ways descriptions show up in discovery and po...
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...