info-contact

Requires the Contact info object defined in your API.

OAS Compatibility
2.0
3.0
3.1
Root
Info
Contact

API design principles

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.

Configuration

Option Type Description
severity string Possible values: off, warn, error. Default off.

An example configuration:

Copy
Copied
styleguide:
  rules:
    info-contact: warn

Examples

Given this configuration:

Copy
Copied
styleguide:
  rules:
    info-contact: error

Example of incorrect contact:

Copy
Copied
info:
  version: 1.0.0
  title: Incorrect example missing contact
  termsOfService: 'https://example.com/terms/'
  license:
    name: Apache 2.0
    url: 'http://www.apache.org/licenses/LICENSE-2.0.html'

Example of correct contact:

Copy
Copied
info:
  contact:
    name: Redocly API Support
    url: https://www.redocly.com/support
    email: support@redocly.com

Related rules

Resources