encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-25 19:14:01 +03:00
Code Issues Packages Projects Releases Wiki Activity

Note AutoSchema limitations on bare APIView (#5649)

Browse Source 
AutoSchema uses GenericAPIView hooks to introspect. If these are not present it’s results will be limited. Note this.

Closes #5121
This commit is contained in:
Carlton Gibson 2017-12-04 10:52:59 +01:00 committed by GitHub
parent a0cdba6277
commit c7df69ab77
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -167,6 +167,18 @@ appropriate Core API `Link` object for the view, request method and path:
(In compiling the schema, `SchemaGenerator` calls `view.schema.get_link()` for (In compiling the schema, `SchemaGenerator` calls `view.schema.get_link()` for
each view, allowed method and path.) each view, allowed method and path.)
---
**Note**: For basic `APIView` subclasses, default introspection is essentially
limited to the URL kwarg path parameters. For `GenericAPIView`
subclasses, which includes all the provided class based views, `AutoSchema` will
attempt to introspect serialiser, pagination and filter fields, as well as
provide richer path field descriptions. (The key hooks here are the relevant
`GenericAPIView` attributes and methods: `get_serializer`, `pagination_class`,
`filter_backends` and so on.)
---
To customise the `Link` generation you may: To customise the `Link` generation you may:
* Instantiate `AutoSchema` on your view with the `manual_fields` kwarg: * Instantiate `AutoSchema` on your view with the `manual_fields` kwarg: