TheDevPath/Navi

document API resources

Aperta

#123 aperta il 17 feb 2018

 (15 commenti) (0 reazioni) (2 assegnatari)JavaScript (63 fork)auto 404
backendgood first issuehelp wantedwiki/documentation

Metriche repository

Star
 (53 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor