valid-uri-format
Overview
This rule belongs to the openapi-v3-syntax-validation ruleset and states that:
String value should be in the format of a proper URI. The URI path can be relative if the Base URI of the referring document is known to help resolve the URI path into an absolute path.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | URI is invalid. |
| Code | OPENAPI3SYNTAX_V223 |
| Type | Validation |
| Rule System | Syntax |
| Broad Category | Miscellaneous |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi syntax validation uri |
Suggested Fixes
- If the URI is a relative path, ensure that the base URI path of the document, in which the URI is specified, is known.
- If the OpenAPI document base URI is not known, ensure that the URI is an absolute path.
- Ensure that the URI does not contain any forbidden characters.