From 6a478e14d7e32aed25e7d7661506de261d6dbea1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cristi=20V=C3=AEjdea?= Date: Thu, 11 Jan 2018 21:20:54 +0100 Subject: [PATCH] Add overriden path parameter example --- testproj/snippets/views.py | 10 ++++++++++ tests/reference.yaml | 7 ++++++- 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/testproj/snippets/views.py b/testproj/snippets/views.py index 462cf69..e4cf7ea 100644 --- a/testproj/snippets/views.py +++ b/testproj/snippets/views.py @@ -3,7 +3,9 @@ from djangorestframework_camel_case.render import CamelCaseJSONRenderer from inflection import camelize from rest_framework import generics +from drf_yasg import openapi from drf_yasg.inspectors import SwaggerAutoSchema +from drf_yasg.utils import swagger_auto_schema from snippets.models import Snippet from snippets.serializers import SnippetSerializer @@ -53,6 +55,14 @@ class SnippetDetail(generics.RetrieveUpdateDestroyAPIView): """patch method docstring""" return super(SnippetDetail, self).patch(request, *args, **kwargs) + @swagger_auto_schema(manual_parameters=[ + openapi.Parameter( + name='id', in_=openapi.IN_PATH, + type=openapi.TYPE_INTEGER, + description="path parameter override", + required=True + ) + ]) def delete(self, request, *args, **kwargs): """delete method docstring""" return super(SnippetDetail, self).patch(request, *args, **kwargs) diff --git a/tests/reference.yaml b/tests/reference.yaml index 0b39daa..7451db0 100644 --- a/tests/reference.yaml +++ b/tests/reference.yaml @@ -339,7 +339,12 @@ paths: delete: operationId: snippetsDelete description: delete method docstring - parameters: [] + parameters: + - name: id + in: path + description: path parameter override + required: true + type: integer responses: '204': description: ''