Requires the Contact info object defined in your API.
| Overlay | Compatibility |
|---|---|
| 1.0 | ✅ |
When it comes to APIs, we generally want more consumers. If they need help to purchase, integrate, or troubleshoot, your contact info should be front and center.
| Option | Type | Description |
|---|---|---|
| severity | string | Possible values: off, warn, error. Default off. |
An example configuration:
rules:
info-contact: warnGiven this configuration:
rules:
info-contact: errorExample of incorrect contact:
info:
version: 1.0.0
title: Incorrect example missing contactExample of correct contact:
info:
contact:
name: Redocly API Support
url: https://www.redocly.com/support
email: team@redocly.com