mirror of
https://github.com/zulip/zulip.git
synced 2025-11-03 13:33:24 +00:00
ac8af3d6de
This commit adds a new endpoint 'users/me/onboarding_steps' deprecating the older 'users/me/hotspots' to mark hotspot as read. We also renamed the view `mark_hotspot_as_read` to `mark_onboarding_step_as_read`. Reason: Our plan is to make this endpoint flexible to support other types of UI elements not just restricted to hotspots.
24 lines
937 B
Python
24 lines
937 B
Python
from django.http import HttpRequest, HttpResponse
|
|
from django.utils.translation import gettext as _
|
|
|
|
from zerver.actions.hotspots import do_mark_onboarding_step_as_read
|
|
from zerver.decorator import human_users_only
|
|
from zerver.lib.exceptions import JsonableError
|
|
from zerver.lib.hotspots import ALL_ONBOARDING_STEPS
|
|
from zerver.lib.request import REQ, has_request_variables
|
|
from zerver.lib.response import json_success
|
|
from zerver.models import UserProfile
|
|
|
|
|
|
@human_users_only
|
|
@has_request_variables
|
|
def mark_onboarding_step_as_read(
|
|
request: HttpRequest, user: UserProfile, onboarding_step: str = REQ()
|
|
) -> HttpResponse:
|
|
if not any(step.name == onboarding_step for step in ALL_ONBOARDING_STEPS):
|
|
raise JsonableError(
|
|
_("Unknown onboarding_step: {onboarding_step}").format(onboarding_step=onboarding_step)
|
|
)
|
|
do_mark_onboarding_step_as_read(user, onboarding_step)
|
|
return json_success(request)
|