Add help/{command} endpoint

[magicmatatjahu]

Suggested by Marc DiPasquale in Slack comment https://asyncapi.slack.com/archives/CQVJXFNQL/p1662141074739369?thread_ts=1661395911.924239&cid=CQVJXFNQL

We should create such an endpoint help/{command} to return instruction of given command to the user. For example help/generate should return available parameters such an available templates etc.

help/{command} is just a suggestion, we can go with other endpoint(s).

Also, what is very important, that endpoint should be done in a similar way as in our main CLI - https://github.com/asyncapi/cli#usage, so main help endpoint should return all available endpoints and particular one like help/generate should return details about given command.

cc @BOLT04 @smoya Do you want to add something, other requirements for task?

[BOLT04]

Hi @magicmatatjahu, I was a bit confused about what was the use case for this endpoint. By reading the thread on slack it makes sense to add the metadata info 👍, I've seen other APIs do that too (e.g. https://cloud.google.com/service-infrastructure/docs/service-metadata/reference/rest; https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_intro.html), although it might be a bit different... dunno 😅.

But I'm still confused about how we'll do it. Regarding naming, meta or metadata would be preferable to help, wdyt?
Since our goal is to provide additional information about our API resources, I think we could have the endpoints match their resource, so generator instead of generate.

I'd also like to ask if developers using this API, are most likely to go to each generator template's GitHub repository, and read the docs for parameters, or call the metadata API with the template id (e.g. "@asyncapi/ts-nats-template")?
wdyt @magicmatatjahu @smoya ?

[asyncapi-bot]

Hello, @tthijm! 👋🏼

I'm Genie from the magic lamp. Looks like somebody needs a hand! 🆘

At the moment the following comments are supported in issues:

• /good-first-issue {js | ts | java | go | docs | design | ci-cd} or /gfi {js | ts | java | go | docs | design | ci-cd} - label an issue as a good first issue.
  example: /gfi js or /good-first-issue ci-cd

[BOLT04]

hi @tthijm, this issue is a part of the GSOC 2023 event, so it'll probably be picked up by students assigned to this project.
But you can look at other issues from this repo, or other AsyncAPI repos if you want to contribute 👍 .

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

[AayushSaini101]

@magicmatatjahu Can i work on this issue ?

[BOLT04]

hi @AayushSaini101 this was already implemented, but feel free to look at other issues 👍