encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-22 17:47:04 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update method override example in Schemas docs (#6887) (#7013)

Browse Source 
get_link() was a method in the old CoreAPI-based AutoSchema implementation.  The new OpenAPI one defines get_operation() instead: the example code block was overlooked.
This commit is contained in:
Aaron Yong 2019-10-24 00:54:37 -06:00 committed by Carlton Gibson
parent 64f567a021
commit 4d57cd31f6
1 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -115,7 +115,6 @@ The `get_schema_view()` helper takes the following keyword arguments:
* `renderer_classes`: May be used to pass the set of renderer classes that can * `renderer_classes`: May be used to pass the set of renderer classes that can
be used to render the API root endpoint. be used to render the API root endpoint.
## Customizing Schema Generation ## Customizing Schema Generation
You may customize schema generation at the level of the schema as a whole, or You may customize schema generation at the level of the schema as a whole, or
@ -155,7 +154,7 @@ Returns a dictionary that represents the OpenAPI schema:
The `request` argument is optional, and may be used if you want to apply The `request` argument is optional, and may be used if you want to apply
per-user permissions to the resulting schema generation. per-user permissions to the resulting schema generation.
This is a good point to override if you want to customise the generated This is a good point to override if you want to customize the generated
dictionary, for example to add custom dictionary, for example to add custom
[specification extensions][openapi-specification-extensions]. [specification extensions][openapi-specification-extensions].
@ -184,14 +183,13 @@ provide richer path field descriptions. (The key hooks here are the relevant
--- ---
In order to customise the operation generation, you should provide an `AutoSchema` subclass, overriding `get_operation()` as you need: In order to customize the operation generation, you should provide an `AutoSchema` subclass, overriding `get_operation()` as you need:
from rest_framework.views import APIView from rest_framework.views import APIView
from rest_framework.schemas.openapi import AutoSchema from rest_framework.schemas.openapi import AutoSchema
class CustomSchema(AutoSchema): class CustomSchema(AutoSchema):
def get_link(...): def get_operation(...):
# Implement custom introspection here (or in other sub-methods) # Implement custom introspection here (or in other sub-methods)
class CustomView(APIView): class CustomView(APIView):
@ -219,4 +217,4 @@ project you may adjust `settings.DEFAULT_SCHEMA_CLASS` appropriately.
[openapi]: https://github.com/OAI/OpenAPI-Specification [openapi]: https://github.com/OAI/OpenAPI-Specification
[openapi-specification-extensions]: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#specification-extensions [openapi-specification-extensions]: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#specification-extensions
[openapi-operation]: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operationObject [openapi-operation]: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operationObject