Requiring that all operational summaries meets the policy standards.
Operation Summary
Rules
OpenAPI Operations Summary Error
You need short and intuitive summary for each API operation helps API consumers understand what is possible with each API request
OpenAPI Operations Summary Info
You need short and intuitive summary for each API operation helps API consumers understand what is possible with each API request
OpenAPI Operations Summary Length Error
Apply length constraints to the operation summary helps keep them consistent for publishing in documentation
OpenAPI Operations Summary Period Error
Operation summaries should not have a period, keeping the primary summary for each API as consistent as possible for publishing in documentation
OpenAPI Operations Summary Period Info
Operation summaries should not have a period, keeping the primary summary foreach API as consistent as possible for publishing in documentation.
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...