valid-example-external-value
Overview
This rule belongs to the apimatic-post-processing-validation ruleset and states that:
The external URL provided for example, from which the example value is retrieved, must be a valid publicly-accessible URL. Otherwise, the URL will be ignored.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | Invalid external URL provided for example has been removed. |
| Code | APIMATICPOSTPROCESS_V506 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Examples |
| Products Impacted | Code Generation, Developer Experience Portal, API Transformer |
| Tags | apimatic postprocessing validation 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.