valid-image-uri
Overview
This rule belongs to the openapi-v3-apimatic-syntax-linting ruleset and states that:
The display image URI for the API must be a non-null and non-empty URI string.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Invalid Image URI found. |
| Code | OPENAPI3APIMATICSYNTAX_L042 |
| Type | Linting |
| Rule System | Syntax |
| Broad Category | OpenAPI Info |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi syntax linting apimatic info image uri |
Suggested Fixes
- URI must be non-null and non-empty.
- The image uri must be an absoute path.
For More Information
- https://docs.apimatic.io/specification-extensions/swagger-codegen-extensions/#api-metadata-extensions
- https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#infoObject
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
- https://docs.apimatic.io/rulesets/overview/