-
-
Notifications
You must be signed in to change notification settings - Fork 33
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add help/{command}
endpoint
#144
Comments
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, 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")? |
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:
|
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. |
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 ❤️ |
@magicmatatjahu Can i work on this issue ? |
hi @AayushSaini101 this was already implemented, but feel free to look at other issues 👍 |
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 examplehelp/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 likehelp/generate
should return details about given command.cc @BOLT04 @smoya Do you want to add something, other requirements for task?
The text was updated successfully, but these errors were encountered: