experience-versioning.html

Explicit, predictable versioning so changes don't break consumers.

30 rules experience: versioning 29 in the file · 1 built-in or validator-only

Run this ruleset

Lint any matching artifact against this ruleset with the OpenLint CLI (the Spectral CLI gives the same results):

npx openlint lint api.yaml \
  --ruleset https://apicommons.org/assets/rulesets/experience-versioning.yaml

Or run every rule, including the 1 that are engine built-ins or need the validator's own functions, in the API Commons validator. The other 29 are inlined in the file below.

Ruleset definition

Download YAML 

Loading…

Rules in this ruleset (30)

Skill Version Semver Agent Skill
API Property Require Versioning APIs.json
Info APIs JSON Specification Version Format APIs.json
Schema Include API Lifecycle APIs.json
Schema Include Change Log APIs.json
Schema Include Deprecation Policy APIs.json
Schema Include Version Comparison APIs.json
Asyncapi Latest Version AsyncAPI engine
Info Asyncapi Version Semver AsyncAPI
Info MCP Protocol Version Dated MCP
Info MCP Version Semver MCP
Info Require Protocol Version MCP
Info Require Version MCP
Info Require Openapi Version 3x OpenAPI
Info Require Openapi Version 3x (Swagger 2.0) OpenAPI
Info Require Version OpenAPI
Info Version Must Be Semver OpenAPI
Info Version Must Use Semver OpenAPI
Info Version Semantic And Stable OpenAPI
Operation Deprecated Require Description OpenAPI
Parameter Deprecated Require Description OpenAPI
Path Include Version OpenAPI
Path No Version Segment OpenAPI
Path URI Versioning Single Version OpenAPI
Response Deprecated Operation Deprecation Header OpenAPI
Response Deprecated Operation Sunset Header OpenAPI
Schema Deprecated Property Require Description OpenAPI
Server URL Include Version OpenAPI
Server URL Include Version (Swagger 2.0) OpenAPI
Tag No Version Info OpenAPI

← All experience rulesets