Requiring that all operational descriptions meets the policy standards.
Description of API Operations
Rules
OpenAPI Operations Description Error
Having a paragraph or two description of each API operation helps API consumers understand what is possible with each API request
OpenAPI Operations Description Info
Having a paragraph or two description of each API operation helps API consumers understand what is possible with each API request
OpenAPI Operations Description Length Error
Having a length limitation for each description of each API operation helps apply constraints to how you describe your APIs, while helping drive consistency across APIs when it comes to search, doc...
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...
menu_book Documentation Beta
Documentation is the API for humans. I generate reference docs from the definition and surround them with the guides, examples, and getting-started material that turn a spec into understanding. Doc...
