asyncapi / cli

CLI to work with your AsyncAPI files. You can validate them and in the future use a generator and even bootstrap a new file. Contributions are welcomed!
https://www.asyncapi.com/tools/cli
Apache License 2.0
185 stars 157 forks source link

Add convert to AsyncAPI from Postman collection support #1516

Closed jonaslagoni closed 1 month ago

jonaslagoni commented 1 month ago

As the PR was just merged, it's now possible to convert Postman collection to AsyncAPI v3, and it should be possible to do this through the CLI. Checkout https://github.com/asyncapi/converter-js?tab=readme-ov-file#postman-collection-to-asyncapi-conversion for how to do it.

https://github.com/asyncapi/converter-js/pull/276

AayushSaini101 commented 1 month ago

Thanks @Souvikns for submitting this issue for Bounty : ) I will take this

Gmin2 commented 1 month ago

Hey @jonaslagoni as i have done #1498 by #1500, i would like to take this

AayushSaini101 commented 1 month ago

Hey @jonaslagoni as i have done #1498, i would like to take this

@Gmin2 After discussion with @Souvikns we decided to submit this issue in the bounty program. Please let me start working on this issue, if you have any doubt let me know thanks for cooperation

ItshMoh commented 1 month ago

@jonaslagoni @Souvikns I want to take this issue. As i have made the specifications for conversion of postman collection into async api . I would love to work on this issue. Here is the link that pr.

aeworxet commented 1 month ago

Bounty Issue's service comment

Text labels: bounty/2024-Q4, bounty/medium, bounty/coding First assignment to regular contributors: 2024-09-20 00:00:00 UTC+12:00 End Of Life after: 2024-10-31 23:59:59 UTC-12:00

@asyncapi/bounty_team

The Bounty Program is not a Mentorship Program. The accepted level of Bounty Program Participants is Middle/Senior.
Regular contributors should explain in meaningful words how they are going to approach the resolution process when expressing a desire to work on this Bounty Issue.
aeworxet commented 1 month ago

@AayushSaini101, @Gmin2, @ItshMoh, please describe how you would approach resolving this Bounty Issue.

dhruvilmehta commented 1 month ago

I can see that we can only export the Postman collection in a JSON file and not in a YAML file. In the Pull Request mentioned, it's converting YAML postman collection file to Async API file. @ItshMoh, Can you guide me on how we can export the Postman collection to a YAML file?

aeworxet commented 1 month ago

@dhruvilmehta Bounty Issues are not collaborative work, and the Bounty Program is not a Mentorship Program. You are expected to be able to deliver the solution autonomously with only a little strategic guidance from the AsyncAPI Maintainer. Please describe how would you approach the resolution of this Bounty Issue, preferably with a coding draft.

AayushSaini101 commented 1 month ago

@Gmin2 Will work on this issue, We have discussed it, and He has done the prerequisite task of this issue

Gmin2 commented 1 month ago

We need to introduced a new option for format parameter named postman(as format was introduced in this ), and then we need to also add isPostmanCollection in convert.js as introduced in this, and finally we need to add a testcase for it

I would like to work on this as part of bounty program

cc @aeworxet, @Souvikns

aeworxet commented 1 month ago

Bounty Issue's Timeline

Complexity Level Assignment Date (by GitHub) Start Date (by BP Rules) End Date (by BP Rules) Draft PR Submission Final PR Merge Start Final PR Merge End
Medium 2024-09-21 2024-10-07 2024-11-17 2024-10-20 2024-11-03 2024-11-17
Please note that the dates given represent deadlines, not specific dates, so if the goal is reached sooner, it's better.
Keep in mind the responsibility for violations of the Timeline.
asyncapi-bot commented 1 month ago

:tada: This issue has been resolved in version 2.6.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

aeworxet commented 1 month ago

Does the code work as expected after the merge of https://github.com/asyncapi/cli/pull/1527?

Gmin2 commented 1 month ago

Does the code work as expected after the merge of #1527?

Screencast from 03-10-24 04:31:19 PM IST.webm cc @aeworxet

aeworxet commented 1 month ago

@Souvikns, as the AsyncAPI Maintainer, who was responsible for the resolution of this Bounty Issue from the AsyncAPI's side, please confirm its technical resolution.

Souvikns commented 1 month ago

I confirm that this bounty issue is resolved succesfully.

aeworxet commented 1 month ago

Bounty Issue Is Completed 🎉

@Gmin2 (githubID 127925465), please go to the AsyncAPI page on Open Collective and submit an invoice for USD 200.00 with the expense title Bounty cli#1516, tag bounty, and full URL of this Bounty Issue in the description.