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

Document all of the server endpoints #5

Closed
victorhooi opened this issue Mar 4, 2018 · 1 comment
Closed

Document all of the server endpoints #5

victorhooi opened this issue Mar 4, 2018 · 1 comment
Labels
documentation Something to update in documentation

Comments

@victorhooi
Copy link
Contributor

The documentation should include a list of all the API and front-end endpoints:

I believe these are all in server.go, right?

https://github.com/schollz/find3/blob/d7fa365637509bf31f34167bc08cfc203d687663/server/main/src/server/server.go

I'm happy to take a stab at this, if you provide some pointers on how you'd like it done =).

@schollz
Copy link
Owner

schollz commented Mar 6, 2018

Yes, I'd be happy if you'd like to try!

I think something like I did previously is fine: https://www.internalpositioning.com/api/

I know there are fancier ways (swagger) and I'm fine with those too, but don't have time to learn them.

@schollz schollz added enhancement New feature or request documentation Something to update in documentation and removed enhancement New feature or request labels Mar 6, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Something to update in documentation
Projects
None yet
Development

No branches or pull requests

2 participants