LukeParke/redocly-cli
1
0
Fork 0
mirror of https://github.com/LukeHagar/redocly-cli.git synced 2025-12-06 04:21:09 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
de80612b5541f2508cbe97fd26eb50f24fc9646d
redocly-cli/docs/rules/info-contact.md
Lorna Jane Mitchell de80612b55 chore: Run prettier on all docs files (#1334)
2023-11-17 09:45:03 +00:00

1.7 KiB
Raw Blame History

slug
slug
/docs/cli/rules/info-contact

info-contact

Requires the Contact info object defined in your API.

OAS Compatibility
2.0 ✅
3.0 ✅
3.1 ✅ 
flowchart TD

Root ==> Info --> Contact

style Contact fill:#codaf9,stroke:#0044d4,stroke-width:5px

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:

rules:
  info-contact: warn

Examples

Given this configuration:

rules:
  info-contact: error

Example of incorrect contact:

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:

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

Related rules

Resources