recognized-file-format
Overview
This rule belongs to the import-validation ruleset and states that:
A file provided must be in a recognized format. The format could be an API description format like OpenAPI, Swagger, API Blueprint, RAML, Postman, Insomnia, WSDL, WADL etc. or a data description format like JSON, JSON Schema, YAML, XML, XML Schema, etc. or a documentation format like Markdown or text .txt.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | File format could not be recognized or is not supported. |
| Code | IMPORT_V103 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | File I/O Content |
| Tags | import api specification api file validation format api description format data description format |
Suggested Fixes
- Ensure that the file is in one of the supported formats only.
- Ensure that the file is either a supported API description format, data description format or a documentation format.
- Make sure that the file contents are complete as that can hinder identification.