Document Nested FKs better. about django-rest-framework

[tomchristie]

Just needs documenting

[ulmus]

Any chance of this landing in trunk soon? It gets tedious to spec all relations using the ("resource", ("title", "description"...)) -syntax :)

[tomchristie]

See tests/serializer.py - test_serializer_class_nesting and test_serializer_classname_nesting.
You can just use a two tuple of the field name that's nested, and the Resource you want to use for the nesting.
I think that'll do exactly what you're looking for (? tho let me know if not...) - I'm just struggling to find the time outside of work to work on the documentation a bit.

[ulmus]

Yup, I finally got around to looking through the source (and found the bug in issue 53 :))
I'd be glad to help out on the documentation if I weren't also swamped in work, doing double shifts atm...

[dokkaebi]

It is a little cumbersome to specify a Resource for a given fk field, because you must then specify all fields. It would be useful to offer a merge, so that we could specify a Resource for one field and still use the defaults for the remaining fields. I accomplish this with something like

  fields=[('user',UserResource) if f.name is 'user' else f.name for f in Player._meta.fields]

but offering something like

fields_to_merge=[('user', UserResource)] 

to the same effect would be handy.

[tomchristie]

@dokkaebi - You can use .include and .exclude, although it's a good example of how it being undocumented at the moment. Try include = [('user', UserResource)]