Multiple nested resources with multiple methods were not displayed. Also
detail_routes andlist_routes with multiple methods. This PR attempts to fix it.
I created a template tag, thatrecursively finds the links inside a given section. What do you guys think?
I am not sure if the format I've given to the generated links it's okay, but it's a start.

Issues related:
#5324
#4391
#4965

Results

Default actions

users: {    list()    create()    read(id)    update(id)}

Single action

users: {    list([page])}

Single detail_route url

users: {    list()    create()    read(id)    update(id)    farmers(id) <--}

More than one detail_route url

users: {    farmers: {        read(id) <--        update(id) <--    }    list()    create()    read(id)    update(id)}

Nested routes

users: {        animals: {            dogs: {                list(user_id, [page]) <--                create(user_id, email, content, created) <--            }            list(user_id, [page]) <--            create(user_id, email, content, created) <--        }        farmers: {            read(id)            update(id)        }        list()        create()        read(id)        update(id)    }

Multiple resources with nested schema

users: {    animals: {        dogs: {            list(user_id, [page])            create(user_id, email, content, created)        }        list(user_id, [page])        create(user_id, email, content, created)    }    farmers: {        read(id)        update(id)    }    list()    create()    read(id)    update(id)}vets: {  <--    animals: {        dogs: {            list(user_id, [page])            create(user_id, email, content, created)         }    }}

Multiple list_route url

users: {    farmers: {        read(id)        update(id)    }    houses: {        read() <--        create() <--    }    list()    create()    read(id)    update(id)}

Single list_route url (houses)

users: {    farmers: {        read(id)        update(id)    }    list()    create()    houses() <--    read(id)    update(id)}

Fix docs multiple nested and multiple methods

ed38371

carltongibson self-assigned this

Aug 15, 2017

carltongibson added the Interactive API Documentation label

Aug 15, 2017

Copy link

Collaborator

carltongibson commentedAug 15, 2017

This is looking good. Thanks!

I'll review fully this week.

carltongibson reviewed

Aug 16, 2017

View reviewed changes

rest_framework/templatetags/rest_framework.py

		defschema_links(section,sec_key=None):
		"""
		Recursively find every link in a schema, even nested.
		"""

Copy link

Collaborator

carltongibsonAug 16, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Is this going to be valid when used as an HTMLid attribute?

Copy link

ContributorAuthor

woileAug 16, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

works fine in firefox and chrome under debian x64

e.g:
http://localhost:8000/docs/#users-animals > dogs > list

also clicking the links on the sidebar work.

Copy link

Collaborator

carltongibsonAug 16, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

What about for the JavaScript data binding inhttps://github.com/encode/django-rest-framework/blob/master/rest_framework/templates/rest_framework/docs/interact.html#L19 ?

Copy link

Collaborator

carltongibson commentedAug 16, 2017•
edited
Loading

@woile I think this is great! 💃🏼

I like theVets > animals > dogs > list example. It suggests the CSS is robust
enough.Flat is better than nested: "If you need more nesting than that you'll
need to modify the CSS for yourself." (This is nice limit to draw.)

Tests: The examples you've give seem to cover the core cases. Can you turn them into
unit tests?

Copy link

Collaborator

carltongibson commentedAug 16, 2017•
edited
Loading

My only question is (inline above) about the JavaScript data-binding — does that break? (I found it did working around this in a worse way (comment) in#5077)

If so returning anid ≈nested-formated-string and then using another template tag for display might be enough...

What do you think?

Copy link

Collaborator

carltongibson commentedAug 16, 2017

HTML 5 Spec says of ids:

The value must not contain any space characters.

I'm sure it'll work for some clients but break in others.

Not conclusive but my mail client makes a mess of it:

I think we should adjust this for robustness sake. 🙂

Copy link

ContributorAuthor

woile commentedAug 16, 2017•
edited
Loading

@carltongibson for the ID's maybe we could use theslugify from django which will convert spaces to hiphens. That'd be a solution to deal with the id related problems, right?

I'll try to make the unittests tomorrow.

Copy link

Collaborator

carltongibson commentedAug 17, 2017

I'll try to make the unittests tomorrow.

Great. Thanks!

I think tests at theschema_links function level will be fine — i.e. just passing a simplified schema document and checking the result; we should be able to trust the wholeregister.filter and rendering steps, which aren't so nice to test anyway.

Fix JS data binding

11bc1fe

Copy link

ContributorAuthor

woile commentedAug 17, 2017•
edited
Loading

@carltongibson I fixed the issues you suggested, tell me what you think.

The generated ID for links now looks like this:
http://localhost:8000/docs/#users-objects-list

And the interaction modal works fine (note: I added a normalize function over thedata-key in the form). The good thing about having spaces in the link is that I can split them without worrying because I know a url won't include one.

I'll be working on the tests now.