required-example-value-or-external-url
Overview
This rule belongs to the apimatic-post-processing-validation ruleset and states that:
An example entry from the multiple examples list must have either an example value set or an alternate external URL from which the example value can be fetched. Otherwise, the example entry will be ignored.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | Example entry has been removed as example value and external URL were both found to be null/empty. |
| Code | APIMATICPOSTPROCESS_V507 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Examples |
| Products Impacted | Code Generation, Developer Experience Portal, API Transformer |
| Tags | apimatic postprocessing validation value sample value example external url external value |
Suggested Fixes
- If an external URL is not available, make sure that the example value is not null or empty.
- If the example value cannot be embedded within your API description file, make sure you set an external publicly-accessible URL that points to that example value.
- Remove the example entry from the multiple examples list.