document API resources

[motosharpley]

Create an API document identifying all the currently available endpoints and the elements within each endpoint.
List of tasks to include in issue description

• Include apidocs tool dependencies in Navi (admin)
• Develop guidelines that contributors should use while documenting their coded APIs
• Update each of the code blocks in controllers directory to comply with guidelines mentioned above. On a closer review that is the one directory that is relevant for this task as the files in routes directory uses the APIs defined in the controllers directory. However if there are any additional files that are providing APIs they need to be included here.
  • google-api-controllers.js
  • saved-directions-controllers.js
  • saved-pins-controller.js
  • search-history-controllers.js
  • users-contoller.js
  • utils-controller.js
• Update contributing guidelines doc to ensure all programmers follow the guidelines before introducing new API code

[tanyagupta]

@sonalikatara Can I help you with this ?

[thesparrow]

Is this still open? @motosharpley I'd like to get my feet wet with the project. Thanks!

[motosharpley]

@thesparrow please coordinate with @tanyagupta she has started on this however there is more to do if you would like to help.
Also your team invite is still pending, once you accept that I can assign issues to you.
Thanks

[tanyagupta]

@thesparrow @sonalikatara we will be implementing apidocs to capture documentation. I plan to update the issue description with a detailed task list soon. Look forward to working with both of you on that

[tanyagupta]

List of tasks to include in issue description

• Include apidocs tool dependencies in Navi (admin)
• Develop guidelines that contributors should use while documenting their coded APIs
• Update each of the code blocks in controllers directory to comply with guidelines mentioned above. On a closer review that is the one directory that is relevant for this task as the files in routes directory uses the APIs defined in the controllers directory. However if there are any additional files that are providing APIs they need to be included here.
  • google-api-controllers.js
  • saved-directions-controllers.js
  • saved-pins-controller.js
  • search-history-controllers.js
  • users-contoller.js
  • utils-controller.js
• Update contributing guidelines doc to ensure all programmers follow the guidelines before introducing new API code

I am marking the one I am interested in (guidelines). Please feel free to choose the ones you want

@motosharpley please advice if you want to break this up into issues and keep it here. If we keep it here, could you amend the issue description using the above

[thesparrow]

Thanks for the reply - I can do the first bulletin - it seems like the rest of the bulletins are tied to the second stage? Or is that a wrong assumption? @motosharpley @tanyagupta Also I'm not sure - do I need to tag you in the posts - or is this seen by people already making comments on the thread? thanks

[tanyagupta]

@thesparrow we would need an admin for the first if I am not mistaken. Let me get the guidelines out as soon as I can (the second one) and that should free up the rest of the bullets. All subscribed folks will automatically get copied on this thread. It looks like @motosharpley @sonalikatara @jkwening and us :)