django-rest-framework/docs/api-guide
Carlton Gibson d54df8c438 Refactor schema generation to allow per-view customisation (#5354)
* Initial Refactor Step

* Add descriptor class
* call from generator
* proxy back to generator for implementation.

* Move `get_link` to descriptor

* Move `get_description` to descriptor

* Remove need for generator in get_description

* Move get_path_fields to descriptor

* Move `get_serializer_fields` to descriptor

* Move `get_pagination_fields` to descriptor

* Move `get_filter_fields` to descriptor

* Move `get_encoding` to descriptor.

* Pass just `url` from SchemaGenerator to descriptor

* Make `view` a property

Encapsulates check for a view instance.

* Adjust API Reference docs

* Add `ManualSchema` class

* Refactor to `ViewInspector` plus `AutoSchema`

The interface then is **just** `get_link()`

* Add `manual_fields` kwarg to AutoSchema

* Add schema decorator for FBVs

* Adjust comments

* Docs: Provide full params in example

Ref feedback b52e372f8f (r137254795)

* Add docstring for ViewInstpector.__get__ descriptor method.

Ref https://github.com/encode/django-rest-framework/pull/5354#discussion_r137265022

* Make `schemas` a package.

* Split generators, inspectors, views.

* Adjust imports

* Rename to EndpointEnumerator

* Adjust ManualSchema to take `fields`

… and `description`.

Allows `url` and `action` to remain dynamic

* Add package/module docstrings
2017-09-14 09:46:34 +01:00
..
authentication.md Add documentation to create user token with the new command 2017-08-13 11:08:44 +01:00
content-negotiation.md Replace "class based views" occurrences with "class-based views" (#4251) 2016-07-08 08:38:50 +01:00
exceptions.md Link broken 2017-06-23 08:09:10 +01:00
fields.md Adjust ListField & DictField signature docs (#5333) 2017-08-17 10:06:09 +01:00
filtering.md Remove ambiguous reference to former DjangoFilterBackend. 2017-05-19 23:50:13 +02:00
format-suffixes.md Replace "class based views" occurrences with "class-based views" (#4251) 2016-07-08 08:38:50 +01:00
generic-views.md Fixed the MultipleFieldLookupMixin example to properly check for object level permission. 2017-09-07 11:06:44 +08:00
metadata.md Fix some typos in documentation 2017-01-08 15:34:52 +02:00
pagination.md Add link to third-party package for LinkHeaderPagination. (#5270) 2017-07-12 16:45:41 +01:00
parsers.md Documentation update (#4717) 2016-11-30 12:58:34 +00:00
permissions.md Update get_object() example in permissions.md (#5401) 2017-09-08 18:51:16 +02:00
relations.md Documentation update (#4717) 2016-11-30 12:58:34 +00:00
renderers.md Add additional link to HTML & Forms topic page (#4726) 2016-12-01 09:11:25 +00:00
requests.md Update requests.md 2016-05-18 08:38:18 +01:00
responses.md Fix doc Response data attribute description 2017-08-23 21:30:56 -05:00
reverse.md Documentation update (#4717) 2016-11-30 12:58:34 +00:00
routers.md typo fix 2017-06-20 15:07:45 -04:00
schemas.md Refactor schema generation to allow per-view customisation (#5354) 2017-09-14 09:46:34 +01:00
serializers.md Update link to drf-writable-nested repository in third-party serializers 2017-08-29 10:39:52 +07:00
settings.md Fix some typos in documentation 2017-01-08 15:34:52 +02:00
status-codes.md Make status_code documentation more readable. (#5400) 2017-09-08 16:53:17 +01:00
testing.md Fix token param in force_authenticate example (#5284) 2017-08-14 13:09:47 +01:00
throttling.md Fix throttling documentation about Remote-Addr (#5414) 2017-09-12 12:08:32 +01:00
validators.md Documentation update (#4717) 2016-11-30 12:58:34 +00:00
versioning.md Fix handling of ALLOWED_VERSIONS and no DEFAULT_VERSION (#4370) 2016-08-10 15:19:56 +01:00
views.md Refactor schema generation to allow per-view customisation (#5354) 2017-09-14 09:46:34 +01:00
viewsets.md Non model Viewset requires base_name when registering to router. 2017-05-19 23:35:25 +02:00