required-paths

Overview

This rule belongs to the swagger-v2-standards-validation ruleset and states that:

The Swagger root object in a Swagger v2.0 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 Swagger object is missing.
Code	SWAGGER20STANDARDS_V004
Type	Validation
Rule System	Semantic
Broad Category	Swagger Root Information
Products Impacted	API Transformer, Code Generation, Developer Experience Portal
Tags	swagger2 swagger 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/2.0.md
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#swagger-object
• https://docs.apimatic.io/rulesets/overview/