contact-defined
Since 0.9.0 · In the rulesets: Strict at error, All at error
This rule checks whether complete contact information is present in an AsyncAPI document.
Rule details
The contact-defined rule ensures that the info.contact object is defined
and that its name, email and url properties are all present and not
empty. Contact information tells consumers of the API whom to ask for help,
report problems to, or notify about their use of the API.
The rule reports:
Contact object is missingwhen there is noinfo.contactobject,Contact name is missing or emptywhennameis missing or empty,Contact email is missingwhenemailis missing or empty,Contact URL is missingwhenurlis missing or empty.
Turn the rule off for APIs used only by the team that owns them.
Examples
Good.
asyncapi: 3.0.0
info:
title: Pet Events
version: 1.0.0
contact:
name: Pet Platform Team
email: pets@your-company.com
url: https://your-company.com/teams/pets
Bad. The contact object is present, but it is not possible to reach the team by email.
asyncapi: 3.0.0
info:
title: Pet Events
version: 1.0.0
contact:
name: Pet Platform Team
url: https://your-company.com/teams/pets
Turn it off or change its severity
In apigenie.yaml, off turns the rule off and warning or error sets its severity; a rule with options takes the severity and the options as a pair, [warning, options]. lint.asyncapi has the details.
commands:
lint:
asyncapi:
rules:
contact-defined: off