valid-openapi-file-naming-conventions

Overview

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

The root OpenAPI document is recommended to be named as either openapi.json or openapi.yaml depending upon the data format used in the file.

Property	Value
Enabled	Yes
Maximum Severity	Information
Message	The root OpenAPI file name does not follow recommended conventions.
Code	OPENAPI3STANDARDS_L001
Type	Linting
Rule System	Semantic
Broad Category	OpenAPI Root Information
Products Impacted	API Transformer, Code Generation, Developer Experience Portal
Tags	openapi3 openapi standards semantic linting name file

Suggested Fixes

• Main or root OpenAPI file is one which contains the OpenAPI version, paths and other information.
• Standardized naming of files helps improve their discoverability for your users.

For More Information

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