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.

Property	Value
Enabled	Yes
Maximum Severity	Error
Message	Required property paths in root OpenAPI object is missing.
Code	OPENAPI3STANDARDS_V004
Type	Validation
Rule System	Semantic
Broad Category	OpenAPI Root Information
Products Impacted	API Transformer, Code Generation, Developer Experience Portal
Tags	openapi3 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

• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#openapi-specification
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#openapi-object
• https://docs.apimatic.io/rulesets/overview/