encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-08-07 13:54:47 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add category/action examples

Browse Source
This commit is contained in:
Tom Christie 2016-08-12 10:46:47 +01:00
parent 8385ac56db
commit 65c7b9d3f0
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
rest_framework/schemas.py
View File

@ -180,6 +180,16 @@ class SchemaGenerator(object):
def get_category(self, path, method, callback, action): def get_category(self, path, method, callback, action):
""" """
Return a descriptive category string for the endpoint, eg. 'users'. Return a descriptive category string for the endpoint, eg. 'users'.
Examples of category/action pairs that should be generated for various
endpoints:
/users/ [users][list], [users][create]
/users/{pk}/ [users][read], [users][update], [users][destroy]
/users/enabled/ [users][enabled] (custom action)
/users/{pk}/star/ [users][star] (custom action)
/users/{pk}/groups/ [groups][list], [groups][create]
/users/{pk}/groups/{pk}/ [groups][read], [groups][update], [groups][destroy]
""" """
path_components = path.strip('/').split('/') path_components = path.strip('/').split('/')
path_components = [ path_components = [