[📑 Docs]: Improve content under Functions section on Glee documentation

[peter-rr]

What Dev Docs changes are you proposing?

I would propose to include some information about subscribe operations under Functions section on Glee documentation.

From my point of view it's pretty clear how Glee interacts with publish operations. However, at the time of building a Glee project I've been wondering what happens then with subscribe operations and their corresponding function files, and some questions came to my mind:

• Should I include the function files from subscribe operations in the Glee functions folder as well? Or should I include only the ones from publish operations?
• Are the functions related to subscribe operations not necessary for Glee as they are not mentioned at all?
• Why some Glee examples include the operationId attribute for subscribe operations? Is it necessary at some point or just ignored by Glee? I found it a bit confusing 🤔

This is the specific part of the document where I think that info about the functions from subscribe operations might be included:

Code of Conduct

• I agree to follow this project's Code of Conduct

[fmvilas]

Yeah, it's a bit awkward but the reasoning is that subscribe in AsyncAPI means that your app is sending a message. The functions folder is there for reacting to the messages received instead. The messages sent by your app must be defined as part of a lifecycle event or as a response to one of the functions in the functions folder.

So, to answer your questions:

Should I include the function files from subscribe operations in the Glee functions folder as well? Or should I include only the ones from publish operations?

Only the publish ones.

Are the functions related to subscribe operations not necessary for Glee as they are not mentioned at all?

They are not needed so far but it's a good point. Might be worth exploring making it work in a different way.

Why some Glee examples include the operationId attribute for subscribe operations? Is it necessary at some point or just ignored by Glee? I found it a bit confusing 🤔

That's definitely confusing. They are not needed at all so they shouldn't be there to avoid confusion.

[octonawish-akcodes]

can i work on this

[fmvilas]

@octonawish-akcodes absolutely 👍 Feel free to give it a try.

[github-actions]

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

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 ❤️