resolvable-resource-path
Overview
This rule belongs to the swagger-v1-validation ruleset and states that:
The path to the API declaration document in a Resource Object provided using the path property must be valid/accessible. This means that when the Resource Listing document's base path is combined with the relative path from the Resource Object's path value, the resulting URL must be publicly accessible and point to a valid API declaration document.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Path provided in the Resource Object is invalid or inaccessible. |
| Code | SWAGGER1_V101 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Resources |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | swagger1 swagger semantic validation path resource |
Suggested Fixes
- Ensure that the API declaration document exists at the path specified in the resource definition.
- Ensure that the API declaration document is publicly accessible and not hidden behind any authentication layer.
- Ensure that the path points to a raw API declaration document and not to some kind of HTML documentation.
- Ensure that the path provided does not have any typos or forbidden characters.
- Ensure that the API declaration document exists relative to the Resource Listing file.