spec icon indicating copy to clipboard operation
spec copied to clipboard

[Feature Request] Support $ref list in channels and components definition

Open TheLand opened this issue 2 years ago • 2 comments

Hi all,

could be useful to get files YAML and the documentation better organized adding the possibility to link to multiple files in channels and components sections using the $ref special key.

Now I have to declare the main asyncapi.yaml file

channels:
  chatusers.get:
    $ref: "./ChatUsers.yaml#/channels/chatusers.get"
  chatusers.get-vars:
    $ref: "./ChatUsers.yaml#/channels/chatusers.get-vars"
  chatusers.delete:
    $ref: "./ChatUsers.yaml#/channels/chatusers.delete"
  chatusers.insights:
    $ref: "./ChatUsers.yaml#/channels/chatusers.insights"

But if I could make something like:

channels:
  - $ref: "./ChatUsers.yaml#/channels"
  - $ref: "./AutomatedMessages.yaml#/channels"

It would be better i think: the main file would stay clean and limited and all specifications stay in their named files. It isn't a breaking change: you could support the old style and this new style.

Hope it's clear.

TheLand avatar Mar 09 '22 10:03 TheLand

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] avatar Jul 08 '22 00:07 github-actions[bot]

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

github-actions[bot] avatar Jul 11 '22 09:07 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] avatar Nov 27 '22 00:11 github-actions[bot]