API Evangelist API Evangelist
API Learnings
Toolbox
API Evangelist LLC

OpenAPI Tags

Requiring that all OpenAPI tags meet the policy standards.

Rules

OpenAPI Tags Description Error

Tags used as part of an OpenAPI needs descriptions, giving more of a narrative behind what a tag means when it is applied to an API

OpenAPI Tags Description Info

Tags used as part of an OpenAPI needs descriptions, giving more of a narrative behind what a tag means when it is applied to an API

OpenAPI Tags Name Error

Tags used as part of an OpenAPI needs names, giving a simple key word or phrase that represents the tag being applied to APIs

OpenAPI Tags Name Info

Tags used as part of an OpenAPI needs names, giving a simple key word or phrase that represents the tag being applied to APIs

OpenAPI Tags Object Error

There needs to be a central tags object applied to the OpenAPI, giving central tags that can be applied across all operations within an OpenAPI

OpenAPI Tags Object Info

There needs to be a central tags object applied to the OpenAPI, giving central tags that can be applied across all operations within an OpenAPI

OpenAPI Tags One Error

There needs to be at least one tag applied to an OpenAPI, giving a key word or phrase that can be applied to API operations

OpenAPI Tags Upper Case Error

The first letter of each word in a tag being applied to APIs needs to be capitalized, keeping the tags being applied across APIs the same look and feel for organizing and publishing to documentation

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, ...