required-resource-listing-apis

Overview

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

The root object of a Swagger v1 Resource Listing document must list the resources to be described by this specification using the apis property.

Property	Value
Enabled	Yes
Maximum Severity	Error
Message	Required property apis in root object of Resource Listing document is missing.
Code	SWAGGER1_V050
Type	Validation
Rule System	Semantic
Broad Category	Resource Listing
Products Impacted	API Transformer, Code Generation, Developer Experience Portal
Tags	swagger1 swagger semantic validation apis resources resource listing

Suggested Fixes

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

For More Information

• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/1.2.md#51-resource-listing
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/1.2.md
• https://docs.apimatic.io/rulesets/overview/