Skip to main content

required-info-version

Overview​

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

The Info Object must specify a version number for the current API specification document using the version property.

PropertyValue
EnabledYes
Maximum SeverityError
MessageRequired property version in Info Object is missing.
CodeOPENAPI3STANDARDS_V011
TypeValidation
Rule SystemSemantic
Broad CategoryInfo
Products ImpactedDeveloper Experience Portal
Tagsopenapi3 openapi standards semantic validation version info metadata

Suggested Fixes​

  • Add missing version property in the Info Object.
  • Make sure that the version property value is not null or empty.
  • The value should indicate the version of the OpenAPI document you are currently drafting. If you are unsure, simply set the value to '1.0'.
  • This version is not the same as the OpenAPI standard version or your API's version.

For More Information​