AsyncAPI: Add `help/{command}` endpoint

[AceTheCreator]

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.

Learn more here asyncapi/server-api#144

Mentors:
@BOLT04

Project Repo:
https://github.com/asyncapi/server-api

Expected Difficulty:
Easy-Medium

Expected Time Commitment:
175 Hour

[sharatkatwa]

I want to work on this project,
Help me getting started

[Harsimar2000]

Greetings! My name is Harsimar, and I am thrilled about this project. I am confident that it will enable developers to build faster and better comprehend end points. To maximize my productivity, I suggest we follow agile methodologies, which have proven effective in my prior experience.

While I will have a part-time job this summer, this project will be my primary focus since it's my first GSoC, and I am genuinely enthusiastic about it. To stay organized in software development, I use Trello, which allows me to view all pending tasks in one place and sort them as I see fit. I'm well-versed in Kanban boards, having used them in previous co-op jobs.

Regarding the weekly schedule, I would appreciate learning more about the project's specifics to get a better idea of what I need to build. Thank you for offering me such a remarkable opportunity, and I wish you a pleasant day/evening.

[]https://www.linkedin.com/in/harsimar-rattan-2a45681a0/

[sv-shivansh]

Hi,
I would really appreciate it if I could get the opportunity to work on this exciting project.
I am sure that it'll be a mutually rewarding experience working together on this project as I will gain a deeper knowledge of the work and together we'll get the project done.
Hoping for a positive response.

[ctnkaan]

Hey there. I'm a final year student with 1.5 years of professional work experience using TypeScript, Node.js, React and other fun tools! I've also been maintaining an open source Cybersecurity Discord bot called Postman Sentinel that I developed for Postman for over a year. I also have 3 years of non professional community building and leading experience. I would love to write a document on my plan to contribute to this project. Is there a template I can follow for the document? @BOLT04

[BOLT04]

Hello @sharatkatwa @Harsimar2000, @sv-shivansh and @ctnkaan , thank you all for wanting to work on this project 😃 !

You can start by taking a look at the contributing guidelines here and follow the checklist 👍

As part of GSoC, you have to submit a proposal first and we'll review it. But you can also start engaging with the AsyncAPI community on any project you want. You can learn more details here too.
For the proposals, you can contact me by email: davidpereira2938@gmail.com

Looking forward to hearing from you all 🙂

[ctnkaan]

Alright, thanks! I'll reach out to you after completing the proposal. 😄

[BOLT04]

Great to hear that @ctnkaan 👍, just a reminder about when the applications start, you can see the details here:

The 2023 GSoC program is open to students and to beginners in open source software development. Contributor applications will open on Monday, March 20, 2023 at 18:00 UTC with a deadline of Tuesday, April 4, 2023 18:00 UTC to submit your application (including your project proposal

[prayutsu]

@BOLT04 I can't find any starter issues in the repository of this project. Can you please suggest some?

[shubhsinha]

I am confident that I possess the requisite skills to contribute to this project. I have practical experience in developing RESTful APIs and working with command-line interface (CLI) tools. Furthermore, I am well-versed with the AsyncAPI CLI tool and its documentation structure, which makes me a suitable candidate for this project.

[princerajpoot20]

Hello,
I’m Prince Rajpoot, 2nd year B-tech student.
I want to contribute to Postman as a part of GSOC 2023.

Postman is a popular tool for API development and testing, and contributing to the project can help you learn more about this area.

I want to suggest an idea:

Data Generator - Random data generator like email, names, zip/postal codes, addresses, mobile number and provide the facility to verify response in random data generator.

What are your views on this? Can I contribute to this idea as a part of GSOC-2023?
I'm really passionate about this project and I believe it has the potential to make a real impact. I would be so grateful for any help you could provide.

-Prince Rajpoot
prince.rajpoot.20@gmail.com

[VishrutAggarwal]

Hello there!

I was going through project ideas for GSoC and I am very interested in the project you have proposed. Creating an endpoint like help/{command} to provide instructions for a given command is a great idea, and I agree with the suggestion. I fully understand that it's important to make sure the endpoint is consistent with the main CLI and provides all the necessary information for users. I will definitely take a look at the asyncapi/cli#usage to make sure that I am in accordance with the guidelines.

The expected difficulty and time commitment also seem reasonable to me. I am also interested in tackling smaller issues that can help me get more familiar with the codebase and show my abilities. Are there any first-time contributor issues available that I could work on to get started?

Looking forward to becoming a potential candidate and contribute to this project!