required-paths

Overview

This rule belongs to the openapi-v3-codegen-linting ruleset and states that:

The API specification must define at least one endpoint path. Endpoint paths represent the URLs that clients can use to interact with the API.

Property	Value
Enabled	Yes
Maximum Severity	Error
Message	No endpoint path found in the specification.
Code	OPENAPI3CODEGEN_L001
Type	Linting
Rule System	Semantic
Broad Category	OpenAPI Root Information
Products Impacted	API Transformer, Code Generation, Developer Experience Portal
Tags	code generation sdks openapi3 openapi semantic linting apimatic no endpoint path

Suggested Fixes

• Define paths under the paths section.
• Add the missing endpoint paths to the specification, ensuring they follow the correct URL pattern and use appropriate HTTP methods.

For More Information

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