added description for api, changes in upload image and file to alibaba method

This commit is contained in:
abutalib-kiwi
2023-08-18 18:37:58 +05:30
parent 150bb9250d
commit 21e006ae2a
6 changed files with 85 additions and 47 deletions
+38 -15
View File
@@ -44,9 +44,20 @@ class ArticleViewSet(GenericViewSet, mixins.CreateModelMixin, mixins.UpdateModel
def create(self, request, *args, **kwargs):
"""
article create api method
:param request:
:param args:
:param kwargs:
:param request: { "title": "string", "description": "string",
"article_cards": [
{ "title": "string",
"description": "string",
"image_name": "string",
"image_url": "string"
} ],
"article_survey": [
{ "question": "string",
"options": [
{ "option": "string",
"is_answer": true }
] }
] }
:return: success message
"""
serializer = self.serializer_class(data=request.data)
@@ -57,9 +68,24 @@ class ArticleViewSet(GenericViewSet, mixins.CreateModelMixin, mixins.UpdateModel
def update(self, request, *args, **kwargs):
"""
article update api method
:param request:
:param args:
:param kwargs:
:param request: article_id,
{ "title": "string", "description": "string",
"article_cards": [
{ "id": 0,
"title": "string",
"description": "string",
"image_name": "string",
"image_url": "string"
} ],
"article_survey": [
{ "id": 0,
"question": "string",
"options": [
{ "id": 0,
"option": "string",
"is_answer": true
} ]
} ] }
:return: success message
"""
article = self.get_object()
@@ -72,8 +98,6 @@ class ArticleViewSet(GenericViewSet, mixins.CreateModelMixin, mixins.UpdateModel
"""
article list api method
:param request:
:param args:
:param kwargs:
:return: list of article
"""
queryset = self.get_queryset()
@@ -86,9 +110,7 @@ class ArticleViewSet(GenericViewSet, mixins.CreateModelMixin, mixins.UpdateModel
def retrieve(self, request, *args, **kwargs):
"""
article detail api method
:param request:
:param args:
:param kwargs:
:param request: article_id
:return: article detail data
"""
queryset = self.get_object()
@@ -98,9 +120,7 @@ class ArticleViewSet(GenericViewSet, mixins.CreateModelMixin, mixins.UpdateModel
def destroy(self, request, *args, **kwargs):
"""
article delete (soft delete) api method
:param request:
:param args:
:param kwargs:
:param request: article_id
:return: success message
"""
article = self.get_object()
@@ -177,7 +197,10 @@ class DefaultArticleCardImagesViewSet(GenericViewSet, mixins.CreateModelMixin, m
def create(self, request, *args, **kwargs):
"""
api method to upload default article card images
:param request:
:param request: {
"image_name": "string",
"image": "image_file"
}
:return: success message
"""
serializer = self.serializer_class(data=request.data)