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

API Documentation #16

Closed
vsreekanti opened this issue Aug 31, 2016 · 6 comments
Closed

API Documentation #16

vsreekanti opened this issue Aug 31, 2016 · 6 comments
Assignees
Milestone

Comments

@vsreekanti
Copy link
Member

Document all the external facing APIs and use something like Swagger to automatically generate API docs for us.

@vsreekanti vsreekanti added this to the v0.1 milestone Aug 31, 2016
@vsreekanti vsreekanti self-assigned this Aug 31, 2016
@tarpdalton
Copy link
Contributor

For storing/displaying ground's documentation, we can create github pages by storing them in the docs folder on the master branch.
Publish Your Project Documentation with GitHub Pages

@vsreekanti
Copy link
Member Author

@tarpdalton With the Swagger implementation, is it possible to have the framework generate standalone HTML files? If so, could we separate that code out for #19?

@vsreekanti
Copy link
Member Author

http://www.ground-context.org/ground/api/ Any idea why this is happening?

@tarpdalton
Copy link
Contributor

It is because the request (to get the JSON) is from ground-context.org not ground-context.github.io/ground/api. I might be able to change the CORS setting or something to allow cross origin requests

@tarpdalton
Copy link
Contributor

I'll see if I can fix it with Crossorigin.me or cors.io Since GitHub has cors disabled

@vsreekanti
Copy link
Member Author

Great, thanks James!

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

2 participants