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

added tests to cover docs sections in custom actions

Browse Source
This commit is contained in:
Dan Bate 2018-06-26 12:47:37 +01:00
parent 65a0d59c70
commit a138cfc627
1 changed files with 42 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
tests/test_schemas.py
View File

@ -104,6 +104,17 @@ class ExampleViewSet(ModelViewSet):
assert self.action assert self.action
return super(ExampleViewSet, self).get_serializer(*args, **kwargs) return super(ExampleViewSet, self).get_serializer(*args, **kwargs)
@action(methods=['get', 'post'], detail=False)
def documented_custom_action(self, request):
"""
get:
A description of the get method on the custom action.
post:
A description of the post method on the custom action.
"""
pass
if coreapi: if coreapi:
schema_view = get_schema_view(title='Example API') schema_view = get_schema_view(title='Example API')
@ -150,6 +161,13 @@ class TestRouterGeneratedSchema(TestCase):
action='get' action='get'
) )
}, },
'documented_custom_action': {
'read': coreapi.Link(
url='/example/documented_custom_action/',
action='get',
description='A description of the get method on the custom action.',
)
},
'read': coreapi.Link( 'read': coreapi.Link(
url='/example/{id}/', url='/example/{id}/',
action='get', action='get',
@ -245,6 +263,23 @@ class TestRouterGeneratedSchema(TestCase):
action='post' action='post'
) )
}, },
'documented_custom_action': {
'read': coreapi.Link(
url='/example/documented_custom_action/',
action='get',
description='A description of the get method on the custom action.',
),
'create': coreapi.Link(
url='/example/documented_custom_action/',
action='post',
description='A description of the post method on the custom action.',
encoding='application/json',
fields=[
coreapi.Field('a', required=True, location='form', schema=coreschema.String(title='A', description='A field description')),
coreapi.Field('b', required=False, location='form', schema=coreschema.String(title='B'))
]
)
},
'update': coreapi.Link( 'update': coreapi.Link(
url='/example/{id}/', url='/example/{id}/',
action='put', action='put',
@ -529,6 +564,13 @@ class TestSchemaGeneratorWithMethodLimitedViewSets(TestCase):
action='get' action='get'
) )
}, },
'documented_custom_action': {
'read': coreapi.Link(
url='/example1/documented_custom_action/',
action='get',
description='A description of the get method on the custom action.',
),
},
'read': coreapi.Link( 'read': coreapi.Link(
url='/example1/{id}/', url='/example1/{id}/',
action='get', action='get',