Skip to main content

contact-information

Requires an existing info.contact object to define nonblank name, email, and url strings.

AttributeValue
CategoryMetadata
MaturityGold
OpenAPISwagger 2.0; OpenAPI 3.0, 3.1, 3.2
StarterOff
Lenient–CompleteError

Intent

Complete ownership details give API consumers clear human and machine-accessible support routes.

Flags

A non-object contact value once, or each missing, non-string, empty, or whitespace-only field among name, email, and url.

Does not flag

An absent contact object—info-contact handles presence—or a contact containing all three nonblank strings. Email and URL syntax are not validated.

See it fail

info:
contact:
name: Team Payments

This produces findings for email and url.

Fix it

info:
contact:
name: Team Payments
email: payments@example.com
url: https://example.com/support/payments

Configure

profiles:
default:
rules:
extends: [recommended]
override:
contact-information: warn

Nearby: info-contact.