Discuss approach for handling Operation object of AsyncAPI document

[KunalNasa]

Two new helper functions have been introduced for the operation object in the helper package.
Reference: Operations.js

Points to discuss

Necessity of These Helpers

Do we truly need these two helpers, or would it be simpler to use the parser API directly inside the components?

Helper Function Scope

Are there any enhancements or additions you would like to suggest for the current helper methods?

Best way to handle AsyncAPI document

Please refer this comment: #1512 (comment)

Since this issue is created for discussion, please feel free to drop your thoughts that are not part of the above points but are related to generating a better README file. For example, handling operation title inside generated readme file.

[KunalNasa]

@derberg opened this issue to address this #1512 (comment) and to cover all the points of discussion that I remember from the last weekly meeting.

Please feel free to let me know if any of the points seem unnecessary or too obvious or if addressing them might introduce unnecessary complexity. I will move accordingly.

[derberg]

my stand is that better have a helper for example for operation.messages().all() instead of repeating the same in multiple different templates.

the templates number will grow and grow.

operation.messages().all() is an API that doesn't belong to generator repo, is a dependency we have no control over, and is a subject for updates, new releases, and potential breaking changes. So for us better long term is for example to just update one helper called for example getOperationMessages than update operation.messages().all() usage in multiple places in the repository

[KunalNasa]

@derberg this sounds good to me. I totally agree with you.

[Adi-204]

@KunalNasa I read above comments in this issue. As per my understanding it was open for discussion and @derberg point make complete sense so can we close this issue or am I missing something that need to be discussed?

[KunalNasa]

@Adi-204 yes, you can close this issue. First two points are discussed and regarding the last point I don't feel any necessity to implement it now. We can implement those features when required.

[Adi-204]

@KunalNasa I can't close the issue - only author or maintainer can close it. you can maybe close with some nice comment why we closed it!

[KunalNasa]

Ohh, alright. 😅
Since this was only meant for discussion and we have discussed the major points, let me close with mark as done.