From 6e072dbb45a102f325fd2de8a0b3ed16cd3688b2 Mon Sep 17 00:00:00 2001 From: Martin Desrumaux Date: Thu, 20 Feb 2020 16:14:31 +0100 Subject: [PATCH] docs --- docs/api-guide/schemas.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/api-guide/schemas.md b/docs/api-guide/schemas.md index 55d49b2c2..8dea70902 100644 --- a/docs/api-guide/schemas.md +++ b/docs/api-guide/schemas.md @@ -303,11 +303,10 @@ class ExampleView(APIView): 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 class CustomSchema(AutoSchema):