Skip to main content

valid-openapi-version

Overview​

This rule belongs to the openapi-v3-standards-validation ruleset and states that:

Your OpenAPI specification's root object must specify a valid OpenAPI standard document version using the openapi property. The value must be a valid semantic version number of the OpenAPI standard document in the 3.0.n or 3.1.n range e.g. 3.0.3, 3.1.0, etc.

PropertyValue
EnabledYes
Maximum SeverityError
MessageVersion number of the OpenAPI standard document is invalid.
CodeOPENAPI3STANDARDS_V002
TypeValidation
Rule SystemSemantic
Broad CategoryOpenAPI Root Information
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic validation version

Suggested Fixes​

  • Supported versions fall under the 3.0.n or 3.1.n range e.g. 3.0.0, 3.1.0, etc.
  • This version is not to be confused with the API version or the API specification document version which is specified using the info.version property.

For More Information​