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

Add a class owner dict to describe path parameters

Browse Source
This commit is contained in:
Grégoire ROCHER 2016-07-28 15:50:31 +02:00
parent 29afba67e1
commit 78aba78f02
2 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
rest_framework/schemas.py
View File

@ -246,10 +246,16 @@ class SchemaGenerator(object):
Return a list of `coreapi.Field` instances corresponding to any Return a list of `coreapi.Field` instances corresponding to any
templated path variables. templated path variables.
""" """
path_descriptions = getattr(view, 'path_fields_descriptions', {})
fields = [] fields = []
for variable in uritemplate.variables(path): for variable in uritemplate.variables(path):
field = coreapi.Field(name=variable, location='path', required=True) field = coreapi.Field(name=variable,
location='path',
required=True,
description=path_descriptions.get(variable, ''),
)
fields.append(field) fields.append(field)
return fields return fields

7
tests/test_schemas.py
View File

@ -36,6 +36,9 @@ class ExampleViewSet(ModelViewSet):
class ExampleView(APIView): class ExampleView(APIView):
permission_classes = [permissions.IsAuthenticatedOrReadOnly] permission_classes = [permissions.IsAuthenticatedOrReadOnly]
path_fields_descriptions = {
'example_id': 'Description of example_id path parameter',
}
def get(self, request, *args, **kwargs): def get(self, request, *args, **kwargs):
"""get documentation""" """get documentation"""
@ -256,7 +259,7 @@ class TestSchemaAndSubSchemaGenerator(TestCase):
url='/{example_id}/example-view/', url='/{example_id}/example-view/',
action='post', action='post',
fields=[ fields=[
coreapi.Field('example_id', required=True, location='path') coreapi.Field('example_id', required=True, location='path', description='Description of example_id path parameter')
] ]
), ),
'read': coreapi.Link( 'read': coreapi.Link(
@ -264,7 +267,7 @@ class TestSchemaAndSubSchemaGenerator(TestCase):
action='get', action='get',
description='get documentation', description='get documentation',
fields=[ fields=[
coreapi.Field('example_id', required=True, location='path') coreapi.Field('example_id', required=True, location='path', description='Description of example_id path parameter')
] ]
) )
}, },