required-info-contact
Overview
This rule belongs to the openapi-v3-docsgen-linting ruleset and states that:
The Info Object must specify contact information using the contact property. This information helps users who may be stuck using your API e.g. you can include contact details of your support team that your API consumers can reach out to.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | Contact information is missing. |
| Code | OPENAPI3DOCSGEN_L053 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Info |
| Products Impacted | Developer Experience Portal |
| Tags | documentation generation documentation docs openapi3 openapi semantic linting apimatic contact info |
Suggested Fixes
- Ensure that the Info Object contains the
contactproperty. - Ensure that the contact details are complete and not empty or null e.g. remember to add the name, url and email.