[3.0.0] External docs/Contact as collection

[magicmatatjahu]

Currently, where External Docs Object and Contact Object (in Info Object) can be defined, only one object of this type can be defined. I wonder if we should allow in version 3.0.0 to define externalDocs and contact as collections. I don't have any "production" use case, however I am thinking out loud. I wonder how the specification might be developed in the coming months/years and we should try to be prepared for incoming changes.

To leave compatibility with both AsyncAPI 2.x.x and OpenAPI we should still leave the possibility to define the discussed objects as a single object (the question is whether we should have compatibility?).

We have to agree on the possibility to define the discussed objects as a collection in the upcoming 3.0.0 release because this will be a breaking change on the tooling side - so we can't do this for the next 3.1.0 release and next ones.

Examples

External Docs (on Message Object)

messageId: userSignup
name: UserSignup
title: User signup
summary: Action to sign a user up.
description: A longer description
contentType: application/json
externalDocs:
  - description: Find more info here
    url: https://example.com
  - description: Another doc
    url: https://example.com

Contact (on Info Object)

contact:
  - name: API Support
    url: https://www.example.com/support
    email: [email protected]
  - name: Second support
    url: https://www.example.com/support2

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart: