From f5fa73dda3da6362cf405a03a81172e82399cd3d Mon Sep 17 00:00:00 2001 From: adiglp <113613176+adiglp@users.noreply.github.com> Date: Fri, 6 Jun 2025 13:21:02 +0200 Subject: [PATCH] Update g_contact_information.md with url field Adding url field as a possible contact detail information --- .../kafka-asynchronous-guidelines/g_contact_information.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/asynchronous-api-guidelines/kafka-asynchronous-guidelines/g_contact_information.md b/asynchronous-api-guidelines/kafka-asynchronous-guidelines/g_contact_information.md index c74cd08..7f59a36 100644 --- a/asynchronous-api-guidelines/kafka-asynchronous-guidelines/g_contact_information.md +++ b/asynchronous-api-guidelines/kafka-asynchronous-guidelines/g_contact_information.md @@ -2,6 +2,8 @@ AsyncAPI specs **MUST** include at least one main contact under the info.contact section. +Aside from _name_ field, which describes the contact information, it supports two fields for the contact detail, _email_ and _url_. It **MUST** contain at least one of them. For _url_, it is suggested to specify an endpoint where the contact detail is clearly reflected. + The spec only allows to include one contact there, but it **MAY** also include additional contacts using extension fields. In case this is done, it **MUST** use the extension field _x-additional-responsibles_. For example: @@ -13,6 +15,7 @@ info: contact: name: "Main point of contact" email: "team_dl@adidas.com" + url: http://www.adidas.com/contact/team_dl x-additional-responsibles: - person2@adidas.com - person3@adidas.com