Add overriden path parameter example

openapi3
Cristi Vîjdea 2018-01-11 21:20:54 +01:00
parent 57d77cc48a
commit 6a478e14d7
2 changed files with 16 additions and 1 deletions

View File

@ -3,7 +3,9 @@ from djangorestframework_camel_case.render import CamelCaseJSONRenderer
from inflection import camelize from inflection import camelize
from rest_framework import generics from rest_framework import generics
from drf_yasg import openapi
from drf_yasg.inspectors import SwaggerAutoSchema from drf_yasg.inspectors import SwaggerAutoSchema
from drf_yasg.utils import swagger_auto_schema
from snippets.models import Snippet from snippets.models import Snippet
from snippets.serializers import SnippetSerializer from snippets.serializers import SnippetSerializer
@ -53,6 +55,14 @@ class SnippetDetail(generics.RetrieveUpdateDestroyAPIView):
"""patch method docstring""" """patch method docstring"""
return super(SnippetDetail, self).patch(request, *args, **kwargs) 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): def delete(self, request, *args, **kwargs):
"""delete method docstring""" """delete method docstring"""
return super(SnippetDetail, self).patch(request, *args, **kwargs) return super(SnippetDetail, self).patch(request, *args, **kwargs)

View File

@ -339,7 +339,12 @@ paths:
delete: delete:
operationId: snippetsDelete operationId: snippetsDelete
description: delete method docstring description: delete method docstring
parameters: [] parameters:
- name: id
in: path
description: path parameter override
required: true
type: integer
responses: responses:
'204': '204':
description: '' description: ''