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 :)

[thesparrow]

Ok! Sounds good! I'll be scoping out the code in the meantime - let me know.

[motosharpley]

We can use this as a master ticket and reference other smaller issues that need more description and are able to be completed in isolation.
I will have to to look at apidocs again but I would assume issue 1 would just be a matter of adding devDependencies to the package.json
Also since multiple people are working on this lets submit PR's to the api-docs feature branch

[tanyagupta]

Thanks Bryan. Will push further PRs to the api-docs branch feature. Sonali and Anna please look at docs folder document name Api_instructions in the api-docs branch. That should help us tackle the rest of the sub issues under this issue. Please post a comment if there are questions.

…

Sent from my iPhone

On Mar 30, 2018, at 3:55 PM, Bryan ***@***.***> wrote: We can use this as a master ticket and reference other smaller issues that need more description and are able to be completed in isolation. I will have to to look at apidocs again but I would assume issue 1 would just be a matter of adding devDependencies to the package.json Also since multiple people are working on this lets submit PR's to the api-docs feature branch — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

[tanyagupta]

@thesparrow and @sonalikatara wanted to check in and see if you saw the instructions and have any questions. I am posting the link here =>
https://github.com/TheDevPath/Navi/blob/api-docs/docs/API_instructions.md
Essentially api-docs helps the automation of documents and the attached describes the kind of changes that need to be made to the files. The list of the files are in the task list above.
I will work on it further but the essentials of what needs to be done are there. We won't be opening new issues so you can pick any one and post a comment so we all know
Please let me know if you have any questions.
Thanks :)

[sonalikatara]

Thank You @tanyagupta I am setting up the Navi project on my local machine right now. Will get back to you if I have any questions, will c\post a comment as soon as I get started.

…

On Sat, Mar 31, 2018 at 3:41 PM, tanyagupta ***@***.***> wrote: @thesparrow <https://github.com/thesparrow> and @sonalikatara <https://github.com/sonalikatara> wanted to check in and see if you saw the instructions and have any questions. I am posting the link here => https://github.com/TheDevPath/Navi/blob/api-docs/docs/API_instructions.md Essentially api-docs helps the automation of documents and the attached describes the kind of changes that need to be made to the files. The list of the files are in the task list above. I will work on it further but the essentials of what needs to be done are there. We won't be opening new issues so you can pick any one and post a comment so we all know Please let me know if you have any questions. Thanks :) — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#123 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AD-IV0_q2IR_Ne1O7pw1wcJSw2AjTqNHks5tkAX9gaJpZM4SJaIA> .

[sonalikatara]

@tanyagupta , the api documentation is already there in all the controllers, do I need to check it or am i missing something.

regarding the item : Update contributing guidelines doc to ensure all programmers follow the guidelines before introducing new API code
Isn't this https://github.com/TheDevPath/Navi/blob/api-docs/docs/API_instructions.md
Please suggest how I can start .

[tanyagupta]

@sonalikatara those are really good questions. Let me update my post so that those answers are there for others to review as well.

[tanyagupta]

@sonalikatara @thesparrow please see updated instructions and feel free to take up any of the above issues, hopefully this provides more guidance.