pyeve / eve-demo

A fully functional REST Web API. Powered by Eve.
Other
256 stars 78 forks source link

Example responses in the README are out of date #9

Closed OptiverTimAll closed 10 years ago

OptiverTimAll commented 10 years ago

For example, the README suggests that you can POST an array of objects to a collection endpoint, and you'll get back an array of result objects. The actual Eve demo behaves as described in the documentation on the Eve "Features" page: it returns an object with an _items key that contains the array of result objects.

Updating the documentation in the README to match the master docs would be good, but tedious - a better idea might just be to link to the master docs on http://python-eve.org/

nicolaiarocci commented 10 years ago

I agree. Keeping the README up to date is getting tedious and prone to errors (I updated them after the 0.4 release but - as you point out - I failed at it). I'll just point to the official docs as you suggest. Thank you!