integreat_cms/api/v3/feedback/search_result_feedback.py
"""
APIv3 app search result feedback endpoint
"""
from __future__ import annotations
from typing import TYPE_CHECKING
from django.http import JsonResponse
if TYPE_CHECKING:
from ....cms.models import Language, Region
from ....cms.models import SearchResultFeedback
from ...decorators import feedback_handler, json_response
@feedback_handler
@json_response
def search_result_feedback(
data: dict[str, str],
region: Region,
language: Language,
comment: str,
rating: bool,
is_technical: bool,
) -> JsonResponse:
"""
Store feedback on app search results in database
:param data: HTTP request body data
:param region: The region of this sitemap's urls
:param language: The language of this sitemap's urls
:param comment: The comment sent as feedback
:param rating: up or downvote, neutral
:param is_technical: is feedback on content or on tech
:return: JSON object according to APIv3 search result feedback endpoint definition
"""
if query := data.get("query"):
SearchResultFeedback.objects.create(
search_query=query,
region=region,
language=language,
rating=rating,
comment=comment,
is_technical=is_technical,
)
return JsonResponse({"success": "Feedback successfully submitted"}, status=201)
return JsonResponse({"error": "Search query is required."}, status=400)