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

Add docs note about disabling schemas for actions

Browse Source
This commit is contained in:
Ryan P Kilby 2018-06-22 17:34:58 -04:00
parent 3feea10bae
commit 16bfa3521b
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/api-guide/schemas.md
View File

@ -243,6 +243,14 @@ You may disable schema generation for a view by setting `schema` to `None`:
... ...
schema = None # Will not appear in schema schema = None # Will not appear in schema
This also applies to extra actions for `ViewSet`s:
class CustomViewSet(viewsets.ModelViewSet):
@action(detail=True, schema=None)
def extra_action(self, request, pk=None):
...
--- ---
**Note**: For full details on `SchemaGenerator` plus the `AutoSchema` and **Note**: For full details on `SchemaGenerator` plus the `AutoSchema` and