valid-example-external-value-url
Overview
This rule belongs to the apimatic-docs-linting ruleset and states that:
The external URL provided for example, from which the example value is retrieved, must be a valid publicly-accessible URL.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | External URL provided for example is invalid. |
| Code | APIMATICDOCS_L109 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | Examples |
| Products Impacted | Developer Experience Portal |
| Tags | portal generation portal docs linting apimatic external value url example value |
Suggested Fixes
- Make sure that the URL is an absolute path.
- Make sure that the URL is publicly accessible. URLs containing localhost are not valid URLs.
- Make sure that the URL does not contain any forbidden characters.