search

encode / django-rest-framework

Web APIs for Django. 🎸
https://www.django-rest-framework.org
Other
28.33k stars 6.84k forks source link

Add some documentation or link to the documentation on ModelViewSets from the generics page. #1027

Closed ghost closed 11 years ago

ghost commented 11 years ago

It isn't clear from the generics documentation that a CreateRetrieveUpdateDestroyAPIView exists. It is called viewsets.ModelViewSet. Make this clearer in the documentation that it is possible to provide full CRUD with the ModelViewSet.

Assign Me. I have a PR coming soon.

tomchristie commented 11 years ago

Assign Me. I have a PR coming soon.

I can only assign folks who're added as maintainers. But great, sling it over and will take a look. Thanks!

tomchristie commented 11 years ago

I think I didn't properly read this the first time around - I'm not sure exactly what doc changes you're suggesting. The ViewSet documentation is the right place for ModelViewSet and it's covered there. CreateRetrieveUpdateDestroyAPIView wouldn't make much sense as a View, as you'll typically perform Create actions from the object's collection endpoint, and Retrieve/Update/Destroy actions from the object's instance endpoint. I'm going to close this off for now, but welcome to discuss further if needed.