Requiring that all OpenAPI tags meet the policy standards.
OpenAPI Tags
Rules
OpenAPI Tags Description Error
Tags used as part of an OpenAPI should have descriptions, providing 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 should have descriptions, providing 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 should have names, providing 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 should have names, providing 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, providing 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, providing 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, providing 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
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 contex...
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...
