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.yaml depending upon the data format used in the file.
|Message||The root OpenAPI file name does not follow recommended conventions.|
|Broad Category||OpenAPI Root Information|
|Products Impacted||API Transformer, Code Generation, Developer Experience Portal|
- 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.