Requiring the info version property meets the policy standards.
Version of APIs
Rules
OpenAPI Info Version Error
Publishing a version for your OpenAPI technical contract helps you communicate change with consumers using Semantic or date-based versioning published to the info version property
OpenAPI Info Version Info
Publishing a version for your OpenAPI technical contract helps you communicate change with consumers using Semantic or date-based versioning published to the info version property
OpenAPI Version Date Info
Publishing a version for your OpenAPI technical contract helps you communicate change with consumers using date-based versioning published to the info version property
OpenAPI Version Semantic Info
Publishing a version for your OpenAPI technical contract helps you communicate change with consumers using Semantic versioning published to the info version property
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...
API Versioning Follows a Defined Standard
All APIs must follow a defined versioning strategy, whether semantic versioning or date-based versioning, with clear policies for how versions are communicated, how consumers are migrated, and how ...
Lifecycle
tag Versioning Define
APIs change, and how you version is how you keep faith with the people who depend on you. I decide my versioning and compatibility strategy at the beginning, not after I have already broken someone...
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...
