Skip to main content

required-paths

Overview

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

The OpenAPI root object in an OpenAPI v3.0.x document must specify the available paths and operations for the API using the paths property.

PropertyValue
EnabledYes
SeverityError
MessageRequired property paths in root OpenAPI object is missing.
CodeOPENAPI3STANDARDS_V004
TypeValidation
Rule SystemSemantic
Broad CategoryOpenAPI Root Information
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic validation paths path

Suggested Fixes

  • Add missing paths property in the root object i.e. in the top level properties of the document.
  • Make sure that the paths property is a valid object and not set as null.

For More Information