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

Documentation of expected JSON #116

Open
gaker opened this issue Jan 19, 2014 · 4 comments
Open

Documentation of expected JSON #116

gaker opened this issue Jan 19, 2014 · 4 comments
Labels

Comments

@gaker
Copy link

gaker commented Jan 19, 2014

I'm not a rails developer. As far as I can tell, EPF is made to work with ActiveModel::Serializer out of the box. It would be really nice if JSON examples were provided in the website documentation so one could structure their API to get up and running with EPF quickly.

Thanks in advance!

@jerel
Copy link

jerel commented Jan 23, 2014

I would also love to see this.

@ghempton
Copy link
Contributor

The documentation needs some serious overhaul. I will try and find time for this.

@gaker
Copy link
Author

gaker commented Jan 23, 2014

thanks @ghempton. If you can setup a base template or let us know where you'd like this kind of documentation to go, I'm happy to try to contribute to it as I get everything figured out. I'm working with django & django-rest-framework, so it requires a bit of wrangling of the output to match what epf expects.

Thanks so much for your work on epf, I really appreciate it.

@ghempton
Copy link
Contributor

I am planning on overhauling the website soon, https://github.com/GroupTalent/epf-website will be where any such documentation will reside.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants