AsyncAPI Best Practices

general > asyncapi-info-contact-properties

Guidance

The asyncapi-info-contact rule will ask you to put in a contact object, and this rule will make sure it has
these important properties: name, url and email.
Putting in the name of the developer/team/department/company responsible for the API, along with the support email
and help-desk/GitHub Issues/whatever URL means people know where to go for help. This can mean more successful use
and adoption of your API.

Message

Include name, url and email in the contact information of the person responsible for maintaining this API.

Examples

valid

asyncapi: 2.0.0
info:
  title: example API
  version: "1.0.0"
  contact:
    url: https://example.com
    name: example
    email: example@example.com
channels: {}

invalid

asyncapi: 2.0.0
info:
  title: example API
  version: "1.0.0"
  contact:
    name: example
channels: {}

Applies to AsyncAPI

Constraint

Type: Declarative Validation