api: Add comments to frame related views

This commit is contained in:
Fam Zheng 2025-02-15 12:17:00 +00:00
parent 2e814fa331
commit ad7e2760f7

View File

@ -1790,6 +1790,9 @@ class CameraRulesView(BaseView):
return JsonResponse(make_camera_rules(q), safe=False) return JsonResponse(make_camera_rules(q), safe=False)
class CameraFrameView(BaseView): class CameraFrameView(BaseView):
'''
handle camera frame upload
'''
name = 'camera-frame' name = 'camera-frame'
def post(self, request): def post(self, request):
@ -1803,6 +1806,9 @@ class CameraFrameView(BaseView):
return JsonResponse({}) return JsonResponse({})
class FramesView(BaseView): class FramesView(BaseView):
'''
get frame list
'''
name = 'frames' name = 'frames'
auth_check = 'admin' auth_check = 'admin'
@ -1835,6 +1841,9 @@ class FramesView(BaseView):
'end': end, 'end': end,
}) })
class FrameView(BaseView): class FrameView(BaseView):
'''
get one frame image from oss
'''
name = 'frame' name = 'frame'
def get(self, request): def get(self, request):
@ -1842,6 +1851,9 @@ class FrameView(BaseView):
return HttpResponse(oss_get(path, bucket=settings.FRAMES_BUCKET), return HttpResponse(oss_get(path, bucket=settings.FRAMES_BUCKET),
content_type='image/jpeg') content_type='image/jpeg')
class DeleteFrameView(BaseView): class DeleteFrameView(BaseView):
'''
delete one frame from oss
'''
name = 'delete-frame' name = 'delete-frame'
auth_check = 'admin' auth_check = 'admin'