File tree Expand file tree Collapse file tree 1 file changed +12
-0
lines changed Expand file tree Collapse file tree 1 file changed +12
-0
lines changed Original file line number Diff line number Diff line change @@ -167,6 +167,18 @@ appropriate Core API `Link` object for the view, request method and path:
167
167
(In compiling the schema, ` SchemaGenerator ` calls ` view.schema.get_link() ` for
168
168
each view, allowed method and path.)
169
169
170
+ ---
171
+
172
+ ** Note** : For basic ` APIView ` subclasses, default introspection is essentially
173
+ limited to the URL kwarg path parameters. For ` GenericAPIView `
174
+ subclasses, which includes all the provided class based views, ` AutoSchema ` will
175
+ attempt to introspect serialiser, pagination and filter fields, as well as
176
+ provide richer path field descriptions. (The key hooks here are the relevant
177
+ ` GenericAPIView ` attributes and methods: ` get_serializer ` , ` pagination_class ` ,
178
+ ` filter_backends ` and so on.)
179
+
180
+ ---
181
+
170
182
To customise the ` Link ` generation you may:
171
183
172
184
* Instantiate ` AutoSchema ` on your view with the ` manual_fields ` kwarg:
You can’t perform that action at this time.
0 commit comments