Mirrors/api-guidelines
1
0
Fork 0
mirror of https://github.com/adidas/api-guidelines.git synced 2025-10-25 15:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update g_contact_information.md with url field

Browse Source 
Adding url field as a possible contact detail information
This commit is contained in:
adiglp
2025-06-06 13:21:02 +02:00
committed by GitHub
parent adf9bd5a60
commit f5fa73dda3
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
asynchronous-api-guidelines/kafka-asynchronous-guidelines/g_contact_information.md
View File

@@ -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