encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-07-28 00:49:49 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs

Browse Source
This commit is contained in:
Martin Desrumaux 2020-02-20 16:14:31 +01:00
parent bb7f43b7b5
commit 6e072dbb45
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -303,11 +303,10 @@ class ExampleView(APIView):
schema = AutoSchema(operation_id_base="Custom") schema = AutoSchema(operation_id_base="Custom")
``` ```
The previous example will generate the following operationid: "ListCustoms", "RetrieveCustom", "UpdateCustom", "PartialUpdateCustom", "DestroyCustom". The previous example will generate the following operationId: "ListCustoms", "RetrieveCustom", "UpdateCustom", "PartialUpdateCustom", "DestroyCustom".
You need to provide the singular form of he operation name. For the list operation, a "s" will be appended at the end of the operation.
You need to provide the singular form of he operation name. For the list operation, a "s" will be append at the end of the name. If you need more configuration over the `operationId` field, you can override the `get_operation_id_base` and `get_operation_id` methods from the `AutoSchema` class:
If you need more configuration over the `operationId` field, you can override the `get_operation_id_base` and `get_operation_id` methods from the `AutoSchema` class.
```python ```python
class CustomSchema(AutoSchema): class CustomSchema(AutoSchema):