Requiring that all operational summaries meets the policy standards.
Operation Summary
Rules
OpenAPI Operations Summary Error
Having short and intuitive summary for each API operation helps API consumers understand what is possible with each API request
OpenAPI Operations Summary Info
Having 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
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...
