Skip to main content

documentation-url-redirection

Overview

This rule belongs to the input-file-validation ruleset and states that:

The URL provided to a file must be publicly accessible and must point directly to a raw file. In some cases where the file points to a public documentation of the API instead of a raw API description file, APIMatic supports auto-redirection to the raw file. The URL may change in this case.

PropertyValue
EnabledYes
Maximum SeverityInformation
MessageUser-provided file URL has been redirected to another URL which points to the required raw file.
CodeINPUTFILE_V004
TypeValidation
Rule SystemSemantic
Broad CategoryFile I/O Accessibility
Tagsapi specification api file validation redirection documentation url path absolute path read

Suggested Fixes

  • Make sure that the URL you provide does not point to some kind of API documentation. The URL must point to a raw file in one of the supported formats.