All OpenAPI definitions must have complete info objects including title, description, version, contact information, license, and terms of service, providing both humans and machines with the context needed to understand, evaluate, and properly use each API.
API Info and Metadata Is Complete and Accurate
Policies
Title of APIs
Requiring the info title property meets the policy standards.
Description of APIs
Requiring the info description property meets the policy standards.
Version of APIs
Requiring the info version property meets the policy standards.
Contact Information for APIs
Requiring that there is a contact included in the OpenAPI info.
License for APIs
Requiring the info license property meets the policy standards.
Terms of Service for APIs
Requiring the info terms of service property meets the policy standards.
OpenAPI Version
Requiring there is the latest version of OpenAPI available.
OpenAPI Tags
Requiring that all OpenAPI tags meet the policy standards.
Experiences
Discovery
The average enterprise maintains approximately 0.5 APIs per employee, making it a constant challenge to track the growing inventory of HTTP APIs being produced and consumed. Enterprises often addre...
Onboarding
Transitioning from API discovery to integration as a consumer requires a well-defined and streamlined API onboarding process. Onboarding begins with discovery and relies heavily on clear documentat...
Quality
The quality of HTTP APIs powering an enterprise tends to decline as the number of ungoverned APIs grows across internal, partner, and public landscapes. Low-quality APIs lead to poor downstream exp...
Consistency
Achieving consistency in the design, delivery, and maintenance of HTTP APIs across an enterprise is a significant challenge—one that often complicates API operations. Small differences, such as var...
Communication
Consistent communication about the production and consumption of APIs is critical for effective enterprise governance. APIs are inherently difficult to visualize, making it essential to invest in m...
