API Evangelist API Evangelist
API Learnings
Toolbox
API Evangelist LLC

Description of APIs

Requiring the info description property meets the policy standards.

Rules

OpenAPI Info Description Error

You need a detailed description as part of the OpenAPI info object helps describe what a collection of paths and operations does for consumers, giving a short, concise, and relevant couple of parag...

OpenAPI Info Description Info

You need a detailed description as part of the OpenAPI info object helps describe what a collection of paths and operations does for consumers, giving a short, concise, and relevant couple of parag...

OpenAPI Info Description Length Error

You need a restriction on the length of the API description expressed as the OpenAPI info description helps provide constraints for consumers when adding a description, and keeps portals, landing p...

Strategies

API Info and Metadata Is Complete and Accurate

The info object in your OpenAPI definition is the first thing both humans and machines encounter, and I am constantly surprised by how often it is incomplete. Title, description, version, contact, ...