urls: Add a new endpoint for hotspot and deprecate the old one.

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.
This commit is contained in:
Prakhar Pratyush
2023-12-01 16:22:41 +05:30
committed by Tim Abbott
parent 62bfc20ebc
commit ac8af3d6de
12 changed files with 66 additions and 44 deletions

View File

@@ -56,7 +56,7 @@ from zerver.views.email_mirror import email_mirror_message
from zerver.views.events_register import events_register_backend
from zerver.views.health import health
from zerver.views.home import accounts_accept_terms, desktop_home, home
from zerver.views.hotspots import mark_hotspot_as_read
from zerver.views.hotspots import mark_onboarding_step_as_read
from zerver.views.invite import (
generate_multiuse_invite_backend,
get_user_invites,
@@ -411,11 +411,11 @@ v1_api_and_json_patterns = [
),
# users/me -> zerver.views.user_settings
rest_path("users/me/avatar", POST=set_avatar_backend, DELETE=delete_avatar_backend),
# users/me/hotspots -> zerver.views.hotspots
# users/me/onboarding_steps -> zerver.views.hotspots
rest_path(
"users/me/hotspots",
"users/me/onboarding_steps",
POST=(
mark_hotspot_as_read,
mark_onboarding_step_as_read,
# This endpoint is low priority for documentation as
# it is part of the web app-specific tutorial.
{"intentionally_undocumented"},