valid-email-address
Overview
This rule belongs to the openapi-v3-syntax-validation ruleset and states that:
String value must be in the format of an email.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Value is not a valid email address. |
| Code | OPENAPI3SYNTAX_V221 |
| Type | Validation |
| Rule System | Syntax |
| Broad Category | Miscellaneous |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi syntax validation email |
Suggested Fixes
- Ensure that the value is not empty or null.
- Ensure that the value does not contain leading or trailing whitespace characters.
For More Information
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#contact-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#contact-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#openapi-specification
- https://docs.apimatic.io/rulesets/overview/