Skip to content
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

Documentation of the FLINT Cloud #121

Open
AayushSaini101 opened this issue May 29, 2022 · 8 comments
Open

Documentation of the FLINT Cloud #121

AayushSaini101 opened this issue May 29, 2022 · 8 comments

Comments

@AayushSaini101
Copy link
Contributor

The documentation of the flint cloud is missing. The curl file only contains a little information.
Missing content of the documentation.
new

  • Project Structure
  • Internal working.
  • Required output of the API.
@ayush78781
Copy link

ayush78781 commented May 29, 2022

@padmajabhol as you were already working on Flint-Cloud. So, please do share your thoughts how we can make easy going.

@soma2000-lang
Copy link

@AayushSaini101 can I work on this

@padmajabhol
Copy link
Member

@padmajabhol as you were already working on Flint-Cloud. So, please do share your thoughts how we can make easy going.

Hi, I must have missed your notif. can you take a look at the curl commands here? https:/moja-global/FLINT.Cloud/blob/master/local/rest_api_gcbm/curl.md
I'm pretty sure this will make more sense?

@ayush78781
Copy link

@padmajabhol as you were already working on Flint-Cloud. So, please do share your thoughts how we can make easy going.

Hi, I must have missed your notif. can you take a look at the curl commands here? https:/moja-global/FLINT.Cloud/blob/master/local/rest_api_gcbm/curl.md I'm pretty sure this will make more sense?

Yes it does make sense. But it's not being updated on the current documentation of Flint Cloud.

@ayush78781
Copy link

@AayushSaini101 can I work on this

Hii @soma2000-lang You can work on this issue. But I would recommend you to explore Flint.cloud project before starting with it. And list out your understanding here of its various api's and their endpoints also the tech blockers you face in the process. Then we can go ahead assigning different parts of it as per the interest. I hope it makes sense. Feel free to ask your queries either here or over the cloud channel in slack.

@ayush78781
Copy link

@HarshCasper can we use SwaggerHUb for an Interactive documentation of rest_apis like this. SwaggerHub Editor uses YAML, but we can import and download both YAML and JSON. By implementing it one doesn't have to set-up the whole project on their local or gcp. They can easily interact and understand various request through Swagger-UI. Do let me know your thoughts over it. If every thing goes good I can move ahead implementing it.

@ayush78781
Copy link

@HarshCasper can we use SwaggerHUb for an Interactive documentation of rest_apis like this. SwaggerHub Editor uses YAML, but we can import and download both YAML and JSON. By implementing it one doesn't have to set-up the whole project on their local or gcp. They can easily interact and understand various request through Swagger-UI. Do let me know your thoughts over it. If every thing goes good I can move ahead implementing it.

@AayushSaini101 What's your thoughts over this.

@shloka-gupta
Copy link
Member

@ayush78781 will you be okay with posting the question over slack?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants